Method: projects.databases.collectionGroups.fields.get

Gets the metadata and configuration for a Field.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collectionId}/fields/{field_id}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Field.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Firestore