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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of all environments associated with a specified Dialogflow CX agent, using a \u003ccode\u003eGET\u003c/code\u003e request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter to identify the agent, in the format \u003ccode\u003eprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>\u003c/code\u003e, and needs the \u003ccode\u003edialogflow.environments.list\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eOptional \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters can be used to manage the number of environments returned and to navigate through multiple pages of results.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes a list of \u003ccode\u003eenvironments\u003c/code\u003e, each detailing an environment object, and a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination if more results are available.\u003c/p\u003e\n"],["\u003cp\u003eThe request must be made using one of two provided OAuth scopes, namely \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/dialogflow\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.environments.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListEnvironmentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the list of all environments in the specified [Agent](/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents#Agent).\n\n### HTTP request\n\n`GET https://{endpoint}/v3/{parent=projects/*/locations/*/agents/*}/environments`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/cx/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [Environments.ListEnvironments](/dialogflow/cx/docs/reference/rest/v3/projects.locations.agents.environments/list#google.cloud.dialogflow.cx.v3.Environments.ListEnvironments).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]