- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Returns the list of all flows in the specified agent.
HTTP request
GET https://{endpoint}/v3/{parent=projects/*/locations/*/agents/*}/flows
Where {endpoint}
is one of the supported service endpoints
.
The URLs use gRPC Transcoding syntax.
Path parameters
parent
string
Required. The agent containing the flows. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>
.
Authorization requires the following IAM
permission on the specified resource parent
:
-
dialogflow.flows.list
Query parameters
pageSize
integer
The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken
string
The nextPageToken value returned from a previous list request.
languageCode
string
The language to list flows for. The following fields are language dependent:
-
Flow.event_handlers.trigger_fulfillment.messages -
Flow.event_handlers.trigger_fulfillment.conditional_cases -
Flow.transition_routes.trigger_fulfillment.messages -
Flow.transition_routes.trigger_fulfillment.conditional_cases
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
Request body
The request body must be empty.
Response body
The response message for Flows.ListFlows
.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"flows"
:
[
{
object (
|
| Fields | |
|---|---|
flows[]
|
The list of flows. There will be a maximum number of items returned based on the pageSize field in the request. |
nextPageToken
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/dialogflow
For more information, see the Authentication Overview .
