Method: projects.databases.documents.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The resource name of the Document to get. In the format: projects/{projectId}/databases/{databaseId}/documents/{document_path}.
|
Query parameters
| Parameters |
mask |
object (DocumentMask)
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 parameter consistency_selector. The consistency mode for this transaction. If not set, defaults to strong consistency. consistency_selector can be only one of the following: |
transaction |
string (bytes format)
Reads the document in a transaction. A base64-encoded string.
|
readTime |
string (Timestamp format)
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 uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Document.
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.documents.get\n\nGets a single document.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name of the Document to get. In the format: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. |\n\n### Query parameters\n\n| Parameters ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `mask` | `object (`[DocumentMask](/docs/firestore/reference/rest/v1/DocumentMask)`)` 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. |\n| Union parameter `consistency_selector`. The consistency mode for this transaction. If not set, defaults to strong consistency. `consistency_selector` can be only one of the following: ||\n| `transaction` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` Reads the document in a transaction. A base64-encoded string. |\n| `readTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` 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 uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Document](/docs/firestore/reference/rest/v1/projects.databases.documents#Document).\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)."]]
