Method: projects.locations.agents.environments.list

Returns the list of all environments in the specified Agent.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The Agent to list all environments for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

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

  • dialogflow.environments.list

Query parameters

Parameters
pageSize

integer

The maximum number of items to return in a single page. By default 20 and at most 100.

pageToken

string

The nextPageToken value returned from a previous list request.

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 Environments.ListEnvironments.

JSON representation
{
  "environments": [
    {
      object (Environment)
    }
  ],
  "nextPageToken": string
}
Fields
environments[]

object (Environment)

The list of environments. There will be a maximum number of items returned based on the pageSize field in the request. The list may in some cases be empty or contain fewer entries than pageSize even if this isn't the last page.

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.