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.
Required. The Environment to list all environments for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>.
Authorization requires the following IAM permission on the specified resource parent:
dialogflow.deployments.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.
The list of deployments. 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 page details how to list all deployments within a specified environment using the Dialogflow API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request method is \u003ccode\u003eGET\u003c/code\u003e, and the endpoint URL structure requires the environment's parent path within the Dialogflow hierarchy.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required and identifies the specific environment, and authorization for listing is required.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e allow for controlling the number of items returned and navigating through multiple pages of results.\u003c/p\u003e\n"],["\u003cp\u003eThe response body returns a JSON structure containing a list of deployment objects and a token for fetching the next page if any.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.environments.deployments.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.ListDeploymentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the list of all deployments in the specified [Environment](/dialogflow/cx/docs/reference/rest/v3beta1/projects.locations.agents.environments#Environment).\n\n### HTTP request\n\n`GET https://{endpoint}/v3beta1/{parent=projects/*/locations/*/agents/*/environments/*}/deployments`\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 [Deployments.ListDeployments](/dialogflow/cx/docs/reference/rest/v3beta1/projects.locations.agents.environments.deployments/list#google.cloud.dialogflow.cx.v3beta1.Deployments.ListDeployments).\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)."]]
