Method: projects.locations.agents.flows.list

Returns the list of all flows in the specified agent.

HTTP request

GET https://dialogflow.googleapis.com/v3/{parent=projects/*/locations/*/agents/*}/flows

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The agent containing the flows. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.flows.list

Query parameters

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

If successful, the response body contains data with the following structure:

The response message for Flows.ListFlows.

JSON representation
{
  "flows": [
    {
      object (Flow)
    }
  ],
  "nextPageToken": string
}
Fields
flows[]

object (Flow)

The list of flows. There will be a maximum number of items returned based on the pageSize field in the request.

nextPageToken

string

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.