Method: projects.databases.collectionGroups.fields.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the field configuration and metadata for this database.
Currently, FirestoreAdmin.ListFields
only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields
with the filter set to indexConfig.usesAncestorConfig:false
or ttlConfig:*
.
HTTP request
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
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. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false or ttlConfig:* .
|
pageSize |
integer
The number of results to return.
|
pageToken |
string
A page token, returned from a previous call to FirestoreAdmin.ListFields , 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.ListFields
.
If successful, the response body contains data with the following structure:
JSON representation |
{
"fields": [
{
object (Field )
}
],
"nextPageToken": string
} |
Fields |
fields[] |
object (Field )
The requested fields.
|
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/datastore
https://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.fields.list\n\nLists the field configuration and metadata for this database.\n\nCurrently, [FirestoreAdmin.ListFields](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields/list#google.firestore.admin.v1.FirestoreAdmin.ListFields) only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields/list#google.firestore.admin.v1.FirestoreAdmin.ListFields) with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields`\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. Currently, [FirestoreAdmin.ListFields](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields/list#google.firestore.admin.v1.FirestoreAdmin.ListFields) only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields/list#google.firestore.admin.v1.FirestoreAdmin.ListFields) with a filter that includes `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`. |\n| `pageSize` | `integer` The number of results to return. |\n| `pageToken` | `string` A page token, returned from a previous call to [FirestoreAdmin.ListFields](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields/list#google.firestore.admin.v1.FirestoreAdmin.ListFields), 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.ListFields](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields/list#google.firestore.admin.v1.FirestoreAdmin.ListFields).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"fields\": [ { object (/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields#Field) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `fields[]` | `object (`[Field](/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.fields#Field)`)` The requested fields. |\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)."]]