[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-21 UTC."],[[["\u003cp\u003eThis API endpoint retrieves the contents of a specified file within a Dataform workspace.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e request to a URL constructed using gRPC Transcoding syntax, requiring a \u003ccode\u003eworkspace\u003c/code\u003e path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003epath\u003c/code\u003e query parameter for the file's location and can optionally specify a \u003ccode\u003erevision\u003c/code\u003e to retrieve a historical version of the file.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains the \u003ccode\u003efileContents\u003c/code\u003e as a base64-encoded string.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/bigquery\u003c/code\u003e OAuth scope and the \u003ccode\u003edataform.workspaces.readFile\u003c/code\u003e IAM permission on the workspace resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.repositories.workspaces.readFile\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ReadFileResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nReturns the contents of a file (inside a Workspace).\n\n### HTTP request\n\n`GET https://dataform.googleapis.com/v1/{workspace=projects/*/locations/*/repositories/*/workspaces/*}:readFile`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\n`workspaces.readFile` response message.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/bigquery`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `workspace` resource:\n\n- `dataform.workspaces.readFile`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]