Method: projects.databases.collectionGroups.indexes.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. A parent name of the form projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}
|
Query parameters
| Parameters |
filter |
string
The filter to apply to list results.
|
pageSize |
integer
The number of results to return.
|
pageToken |
string
A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
|
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 requested indexes.
|
nextPageToken |
string
A page token that may be used to request another page of results. If blank, this is the last page.
|
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.collectionGroups.indexes.list\n\nLists composite indexes.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. A parent name of the form `projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` The filter to apply to list results. |\n| `pageSize` | `integer` The number of results to return. |\n| `pageToken` | `string` A page token, returned from a previous call to [FirestoreAdmin.ListIndexes](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/list#google.firestore.admin.v1.FirestoreAdmin.ListIndexes), that may be used to get the next page of results. |\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/v1/projects.databases.collectionGroups.indexes/list#google.firestore.admin.v1.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/Shared.Types/FieldOperationMetadata#Index) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------|\n| `indexes[]` | `object (`[Index](/docs/firestore/reference/rest/Shared.Types/FieldOperationMetadata#Index)`)` The requested indexes. |\n| `nextPageToken` | `string` A page token that may be used to request another page of results. If blank, this is the last page. |\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)."]]
