Method: projects.locations.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists information about the supported locations for this service.
HTTP request
GET https://firestore.googleapis.com/v1/{name=projects/*}/locations
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
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:
| JSON representation |
{
"locations": [
{
object (Location)
}
],
"nextPageToken": string
} |
| Fields |
locations[] |
object (Location)
A list of locations that matches the specified filter in the request.
|
nextPageToken |
string
The standard List next-page token.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-26 UTC.
[null,null,["Last updated 2025-08-26 UTC."],[],[],null,["# Method: projects.locations.list\n\nLists information about the supported locations for this service.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{name=projects/*}/locations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------|\n| `name` | `string` The resource that owns the locations collection, if applicable. |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://google.aip.dev/160). |\n| `pageSize` | `integer` The maximum number of results to return. If not set, the service selects a default. |\n| `pageToken` | `string` A page token received from the `nextPageToken` field in the response. Send that page token to receive the subsequent page. |\n| `extraLocationTypes[]` | `string` Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [Locations.ListLocations](/docs/firestore/reference/rest/v1/projects.locations/list#google.cloud.location.Locations.ListLocations).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"locations\": [ { object (/docs/firestore/reference/rest/v1/projects.locations#Location) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `locations[]` | `object (`[Location](/docs/firestore/reference/rest/v1/projects.locations#Location)`)` A list of locations that matches the specified filter in the request. |\n| `nextPageToken` | `string` The standard List next-page token. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
