Method: projects.databases.collectionGroups.fields.list

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.

HTTP request

GET https://firestore.googleapis.com/v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

A parent name of the form projects/{project_id}/databases/{database_id}/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 the filter set to indexConfig.usesAncestorConfig:false.

pageSize

number

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

If successful, the response body contains data with the following structure:

The response for FirestoreAdmin.ListFields.

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 Authentication Overview.