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 API endpoint retrieves the contents of a specified directory within a Dataform workspace.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses a \u003ccode\u003eGET\u003c/code\u003e HTTP method and requires the workspace name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters like \u003ccode\u003epath\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e allow for specifying the target directory, controlling the number of results returned, and paginating through results.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003edirectoryEntries\u003c/code\u003e and an optional \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving subsequent pages of results.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this API requires specific OAuth scopes (\u003ccode\u003ecloud-platform\u003c/code\u003e or \u003ccode\u003ebigquery\u003c/code\u003e) and the \u003ccode\u003edataform.workspaces.queryDirectoryContents\u003c/code\u003e IAM permission.\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/v1beta1/{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)."]]