Authorization requires the following IAM permission on the specified resource workspace:
dataform.workspaces.queryDirectoryContents
Query parameters
Parameters
path
string
Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
pageSize
integer
Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken
string
Optional. Page token received from a previous workspaces.queryDirectoryContents call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to workspaces.queryDirectoryContents, with the exception of pageSize, must match the call that provided the page token.
[[["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 endpoint retrieves the contents of a specified directory within a Dataform Workspace.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires a \u003ccode\u003eworkspace\u003c/code\u003e path parameter, and supports optional \u003ccode\u003epath\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e query parameters to filter and paginate results.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the response body contains a list of directory entries and a token for retrieving subsequent pages if applicable.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires the \u003ccode\u003edataform.workspaces.queryDirectoryContents\u003c/code\u003e IAM permission on the target workspace and one of two OAuth scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe server will return a JSON representation detailing the requested directory contents.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.repositories.workspaces.queryDirectoryContents\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.QueryDirectoryContentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nReturns the contents of a given Workspace directory.\n\n### HTTP request\n\n`GET https://dataform.googleapis.com/v1/{workspace=projects/*/locations/*/repositories/*/workspaces/*}:queryDirectoryContents`\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.queryDirectoryContents` 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.queryDirectoryContents`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]