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 resource that owns the locations collection, if applicable.
Query parameters
Parameters
filter
string
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
pageSize
integer
The maximum number of results to return. If not set, the service selects a default.
pageToken
string
A page token received from the nextPageToken field in the response. Send that page token to receive the subsequent page.
extraLocationTypes[]
string
Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
Request body
The request body must be empty.
Response body
The response message for Locations.ListLocations.
If successful, the response body contains data with the following structure:
[[["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-08-21 UTC."],[[["\u003cp\u003eThis service retrieves a list of supported locations using an HTTP GET request to a specified endpoint, with the endpoint determined by the service being used.\u003c/p\u003e\n"],["\u003cp\u003eThe request includes a path parameter, \u003ccode\u003ename\u003c/code\u003e, which specifies the resource that owns the locations collection.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003epageSize\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e allow users to refine their search by filtering results, setting a limit to the number of results, and getting the subsequent page of results, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe response body is in JSON format, containing an array of \u003ccode\u003elocations\u003c/code\u003e that match the specified criteria and a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, if needed.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this service requires one of the specified OAuth scopes, \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.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.ListLocationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists information about the supported locations for this service.\n\n### HTTP request\n\n`GET https://{endpoint}/v3/{name=projects/*}/locations`\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 `Locations.ListLocations`.\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)."]]