- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Lists Workspaces in a given Repository.
HTTP request
 GET https://dataform.googleapis.com/v1/{parent=projects/*/locations/*/repositories/*}/workspaces 
The URL uses gRPC Transcoding syntax.
Path parameters
parent 
 string 
Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/* 
.
Authorization requires the following IAM 
permission on the specified resource parent 
:
-  dataform.workspaces.list
Query parameters
| Parameters | |
|---|---|
| pageSize |   Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. | 
| pageToken |   Optional. Page token received from a previous  When paginating, all other parameters provided to  | 
| orderBy |   Optional. This field only supports ordering by  | 
| filter |   Optional. Filter for the returned list. | 
Request body
The request body must be empty.
Response body
 workspaces.list 
response message.
If successful, the response body contains data with the following structure:
| JSON representation | 
|---|
|  { 
 "workspaces" 
 : 
 [ 
 { 
 object (  | 
| Fields | |
|---|---|
| workspaces[] |   List of workspaces. | 
| nextPageToken |   A token, which can be sent as  | 
| unreachable[] |   Locations which could not be reached. | 
Authorization scopes
Requires one of the following OAuth scopes:
-  https://www.googleapis.com/auth/cloud-platform
-  https://www.googleapis.com/auth/bigquery
For more information, see the Authentication Overview .
IAM Permissions
Requires the following IAM 
permission on the parent 
resource:
-  dataform.workspaces.list
For more information, see the IAM documentation .

