- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists workflows in a given project and location. The default order is not specified.
HTTP request
GET https://workflows.googleapis.com/v1/{parent=projects/*/locations/*}/workflows
The URL uses gRPC Transcoding syntax.
Path parameters
parent
string
Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}
Authorization requires the following IAM
permission on the specified resource parent
:
-
workflows.workflows.list
Query parameters
| Parameters | |
|---|---|
pageSize
|
Maximum number of workflows to return per call. The service might return fewer than this value even if not at the end of the collection. If a value is not specified, a default value of 500 is used. The maximum permitted value is 1000 and values greater than 1000 are coerced down to 1000. |
pageToken
|
A page token, received from a previous When paginating, all other parameters provided to |
filter
|
Filter to restrict results to specific workflows. For details, see AIP-160 . For example, if you are using the Google APIs Explorer: or |
orderBy
|
Comma-separated list of fields that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a "desc" suffix. If not specified, the results are returned in an unspecified order. |
Request body
The request body must be empty.
Response body
Response for the workflows.list
method.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"workflows"
:
[
{
object (
|
| Fields | |
|---|---|
workflows[]
|
The workflows that match the request. |
nextPageToken
|
A token, which can be sent as |
unreachable[]
|
Unreachable resources. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .

