Method: projects.databases.documents.get
Gets a single document.
HTTP request
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
The URL usesgRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
Required. The resource name of the Document to get. In the format: |
Query parameters
| Parameters | |
|---|---|
mask |
The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. |
Union parameterconsistency_selector. The consistency mode for this transaction. If not set, defaults to strong consistency.consistency_selector can be only one of the following: | |
transaction |
Reads the document in a transaction. A base64-encoded string. |
readTime |
Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance ofDocument.
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 theOAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-26 UTC.