Method: projects.databases.indexes.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the indexes that match the specified filters.
HTTP request
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The database name. For example: projects/{projectId}/databases/{databaseId}
|
Query parameters
| Parameters |
filter |
string
|
pageSize |
integer
The standard List page size.
|
pageToken |
string
The standard List page token.
|
Request body
The request body must be empty.
Response body
The response for FirestoreAdmin.ListIndexes.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"indexes": [
{
object (Index)
}
],
"nextPageToken": string
} |
| Fields |
indexes[] |
object (Index)
The indexes.
|
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-06-20 UTC.
[null,null,["Last updated 2025-06-20 UTC."],[],[],null,["# Method: projects.databases.indexes.list\n\nLists the indexes that match the specified filters.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` The database name. For example: `projects/{projectId}/databases/{databaseId}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------|\n| `filter` | `string` |\n| `pageSize` | `integer` The standard List page size. |\n| `pageToken` | `string` The standard List page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response for [FirestoreAdmin.ListIndexes](/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/list#google.firestore.admin.v1beta1.FirestoreAdmin.ListIndexes).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"indexes\": [ { object (/docs/firestore/reference/rest/v1beta1/projects.databases.indexes#Index) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------|\n| `indexes[]` | `object (`[Index](/docs/firestore/reference/rest/v1beta1/projects.databases.indexes#Index)`)` The indexes. |\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)."]]
