Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details .

Method: projects.locations.agents.list

HTTP request
Path parameters
Query parameters
Request body
Response body
- JSON representation
Authorization scopes
Try it!

Returns the list of all agents in the specified location.

HTTP request

GET https://{endpoint}/v3beta1/{parent=projects/*/locations/*}/agents

Where {endpoint} is one of the supported service endpoints .

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters

parent

string

Required. The location to list all agents for. Format: projects/<ProjectID>/locations/<LocationID> .

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

dialogflow.agents.list

Query parameters

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.

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.

Request body

The request body must be empty.

Response body

The response message for Agents.ListAgents .

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

JSON representation
{ "agents" : [ { object ( `Agent` ) } ] , "nextPageToken" : string }

Fields

Fields
`agents[]`	`object ( Agent )` The list of agents. 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.

agents[]

object ( Agent )

The list of agents. 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 .