Firestore.projects.databases.documents.batch Get

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

POST/v1/{database}/documents:batchGet

Use it in a workflow

Add a step and choose the Firestore connector.
Pick the Firestore.projects.databases.documents.batch Get action (under projects).
Fill in the fields below, then reference the result from later steps as {{firestoreProjectsDatabasesDocumentsBatchGet.response.data}}.

Request

Path parameters

databasestringrequired

Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

Request body

Enter the body as JSON in the step's Body field.

documentsarray<string>

The names of the documents to retrieve. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.

maskobject

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.

fieldPathsarray<string>

The list of field paths in the mask. See Document.fields for a field path syntax reference.

newTransactionobject

Options for creating a new transaction.

readOnlyobject1 fields

Options for a transaction that can only be used to read documents.

readWriteobject1 fields

Options for a transaction that can be used to read and write documents.

readTimestring (google-datetime)

Reads documents as they were at the given time. This may not be older than 270 seconds.

transactionstring (byte)

Reads documents in a transaction.

json

{
  "documents": [
    "string"
  ],
  "mask": {
    "fieldPaths": [
      "string"
    ]
  },
  "newTransaction": {
    "readOnly": {
      "readTime": "string"
    },
    "readWrite": {
      "retryTransaction": "string"
    }
  },
  "readTime": "string",
  "transaction": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{firestoreProjectsDatabasesDocumentsBatchGet.response.data.<field>}}.

foundobject

A Firestore document. Must not exceed 1 MiB - 4 bytes.

createTimestring (google-datetime)

Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.

fieldsobject

The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.

namestring

The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

updateTimestring (google-datetime)

Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.

missingstring

A document name that was requested but does not exist. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

readTimestring (google-datetime)

The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.

transactionstring (byte)

The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.

json

{
  "found": {
    "createTime": "string",
    "fields": {},
    "name": "string",
    "updateTime": "string"
  },
  "missing": "string",
  "readTime": "string",
  "transaction": "string"
}

Need more? See the Firestore guide for connection setup and behaviour shared by every action.

Was this page helpful?