Firebase Firestore

Read and write documents in Firebase Firestore - query collections, update fields, run atomic counters and aggregate without reading.

Actions

Action	What it does
Add to an array field	Add values to an array on a document, skipping any already there, so running the step twice does not duplicate an entry.
Count documents	Count the documents matching a filter without reading them, which costs a fraction of the equivalent query.
Create document	Add a document to a collection.
Create or update document	Write a document at a known path, creating it if it is not there.
Create several documents	Create a list of documents in one collection, all or nothing.
Delete document	Delete one document.
Delete several documents	Delete a list of documents by path, all or nothing.
Empty a collection	Delete the documents in a collection, in batches.
Get database settings	Read one database's location, edition, concurrency mode and delete protection.
Get document	Read one document by its path.
Get several documents	Read a list of documents by path in one round trip.
Increment a field	Add to a number stored on a document, atomically.
List collections	List the collections at the top of the database, or the subcollections under one document.
List databases	List the Firestore databases in this project, with their locations and editions.
List documents	List the documents in a collection, a page at a time.
Query documents	Find the documents in a collection matching one or more field filters, sorted however you like.
Remove from an array field	Remove every occurrence of the given values from an array on a document.
Stamp a field with the server time	Set a field to the moment Firestore applies the write, using Firestore's clock rather than this machine's.
Total or average a field	Add up or average a numeric field across the matching documents, without reading them.
Update document	Change some fields on a document that already exists, leaving every other field alone.

Add to an array field

Add values to an array on a document, skipping any already there, so running the step twice does not duplicate an entry.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Fieldfield_nametextRequired: Which field to change. A dot means a nested field, so "stats.views" is views inside the stats object.
ValuesvalueslistRequired: The values to use. Values are ordinary JSON. For the types JSON has no syntax for, use {"$timestamp": "2026-09-05T10:30:00Z"}, {"$geopoint": {"latitude": 52.5, "longitude": 13.4}}, {"$reference": "users/alice"} or {"$bytes": "<base64>"}.

Outputs

fieldtext
pathtext
updated_timetext
value

Example output

{
  "field": "tags",
  "path": "users/alice",
  "updated_time": "2026-09-05T11:12:00.000000Z",
  "value": null
}

Count documents

Count the documents matching a filter without reading them, which costs a fraction of the equivalent query.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
Filtersfilterslist: Which documents to match. Each filter is a field, an operator and a value - for example {"field": "status", "operator": "EQUAL", "value": "open"}. The four IS_NULL/IS_NOT_NULL/IS_NAN/IS_NOT_NAN operators test the field on their own and take no value; IN, NOT_IN and ARRAY_CONTAINS_ANY take a list. Leave empty to match every document. Filtering or sorting on more than one field needs a composite index - Firestore's error carries a link that creates it.
Combine filters withcombine_filterstext: Whether a document has to match every filter or just one.One of: AND (Match every filter (AND)), OR (Match any filter (OR)). Default: AND.
Include subcollections with the same nameinclude_subcollectionstrue/false: Search every collection with this id anywhere in the database, not just the one at this path - Firestore calls it a collection group query. Use it to read, say, every 'comments' subcollection under every post at once.Default: false.

Outputs

collectiontext
countnumber

Example output

{
  "collection": "users",
  "count": 128
}

Create document

Add a document to a collection. Leave the id empty and Firestore mints one.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
Fieldsfieldsobject: The fields to store, as an object. A dot in a field name means a nested field, so "address.city" writes city inside the address object and leaves the rest of address alone. Values are ordinary JSON. For the types JSON has no syntax for, use {"$timestamp": "2026-09-05T10:30:00Z"}, {"$geopoint": {"latitude": 52.5, "longitude": 13.4}}, {"$reference": "users/alice"} or {"$bytes": "<base64>"}.
Document iddocument_idtext: The id to give the document. Leave empty for a Firestore-generated one, which spreads writes evenly; a counting id such as user1, user2 concentrates them on one part of the database and slows it down.

Outputs

collectiontext
created_timetext
fieldsobject
idtext
nametext
pathtext
updated_timetext

Example output

{
  "collection": "users",
  "created_time": "2026-09-05T10:30:00.123456Z",
  "fields": {
    "active": true,
    "name": "Ada",
    "score": 42
  },
  "id": "kj4Yd2mQpLxV8nRt",
  "name": "projects/demo-project/databases/(default)/documents/users/kj4Yd2mQpLxV8nRt",
  "path": "users/kj4Yd2mQpLxV8nRt",
  "updated_time": "2026-09-05T10:30:00.123456Z"
}

Create or update document

Write a document at a known path, creating it if it is not there. Choose whether to merge with what is already stored or replace it.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
FieldsfieldsobjectRequired: The fields to write. A dot in a field name means a nested field, so "address.city" writes city inside the address object and leaves the rest of address alone. Values are ordinary JSON. For the types JSON has no syntax for, use {"$timestamp": "2026-09-05T10:30:00Z"}, {"$geopoint": {"latitude": 52.5, "longitude": 13.4}}, {"$reference": "users/alice"} or {"$bytes": "<base64>"}.
If the document already existsmodetext: Merge keeps fields you have not listed. Replace deletes them, leaving the document holding exactly what is here.One of: merge (Merge - keep any field not listed here), replace (Replace - delete any field not listed here). Default: merge.

Outputs

collectiontext
created_timetext
fieldsobject
idtext
nametext
pathtext
updated_timetext

Example output

{
  "collection": "users",
  "created_time": "2026-09-01T08:00:00.000000Z",
  "fields": {
    "name": "Ada",
    "score": 42
  },
  "id": "alice",
  "name": "projects/demo-project/databases/(default)/documents/users/alice",
  "path": "users/alice",
  "updated_time": "2026-09-05T11:05:00.000000Z"
}

Create several documents

Create a list of documents in one collection, all or nothing. Fails without writing anything if any of the ids is already taken.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
DocumentsdocumentslistRequired: Each entry needs an 'id' and the fields to store alongside it. At most 500 per call. Values are ordinary JSON. For the types JSON has no syntax for, use {"$timestamp": "2026-09-05T10:30:00Z"}, {"$geopoint": {"latitude": 52.5, "longitude": 13.4}}, {"$reference": "users/alice"} or {"$bytes": "<base64>"}.

Outputs

collectiontext
commit_timetext
countnumber
pathslist

Example output

{
  "collection": "users",
  "commit_time": "2026-09-05T11:20:00.000000Z",
  "count": 2,
  "paths": [
    "users/alice",
    "users/bob"
  ]
}

Delete document

Delete one document. Any subcollections under it are left in place - Firestore does not delete those with the parent.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Fail if it is not theremust_existtrue/false: Firestore treats deleting a missing document as a success. Turn this on to hear about a path that matched nothing instead.Default: false.

Outputs

deletedtrue/false
pathtext

Example output

{
  "deleted": true,
  "path": "users/alice"
}

Delete several documents

Delete a list of documents by path, all or nothing.

Inputs

Document pathsdocumentslistRequired: The paths to delete, such as users/alice. At most 500 at a time.

Outputs

commit_timetext
countnumber
deletedtrue/false
pathslist

Example output

{
  "commit_time": "2026-09-05T11:25:00.000000Z",
  "count": 2,
  "deleted": true,
  "paths": [
    "users/alice",
    "users/bob"
  ]
}

Empty a collection

Delete the documents in a collection, in batches. Subcollections under those documents are left alone - empty them by naming their own path.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
Delete at mostlimitnumber: How many documents to delete in this run, at most 500. If reached_limit comes back true there are more left - run the step again.From 1 to 500. Default: 25.

Outputs

collectiontext
deleted_countnumber
pathslist
reached_limittrue/false

Example output

{
  "collection": "scratch",
  "deleted_count": 3,
  "paths": [
    "scratch/a",
    "scratch/b",
    "scratch/c"
  ],
  "reached_limit": false
}

Get database settings

Read one database's location, edition, concurrency mode and delete protection.

Inputs

Databasedatabasetext: Which database to read. Leave empty for the one this connection uses.

Outputs

concurrency_modetext
created_timetext
delete_protectiontext
editiontext
idtext
locationtext
nametext
point_in_time_recoverytext
typetext
updated_timetext

Example output

{
  "concurrency_mode": "PESSIMISTIC",
  "created_time": "2026-01-04T09:00:00.000000Z",
  "delete_protection": "DELETE_PROTECTION_DISABLED",
  "edition": "STANDARD",
  "id": "(default)",
  "location": "nam5",
  "name": "projects/demo-project/databases/(default)",
  "point_in_time_recovery": "POINT_IN_TIME_RECOVERY_DISABLED",
  "type": "FIRESTORE_NATIVE",
  "updated_time": "2026-01-04T09:00:00.000000Z"
}

Get document

Read one document by its path.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Only these fieldsselect_fieldslist: Return just these fields instead of the whole document. Leave empty for everything. Reading fewer fields does not reduce what Firestore charges for the read, but it does keep a large document out of the workflow.

Outputs

collectiontext
created_timetext
fieldsobject
idtext
nametext
pathtext
updated_timetext

Example output

{
  "collection": "users",
  "created_time": "2026-09-01T08:00:00.000000Z",
  "fields": {
    "active": true,
    "name": "Ada",
    "score": 42
  },
  "id": "alice",
  "name": "projects/demo-project/databases/(default)/documents/users/alice",
  "path": "users/alice",
  "updated_time": "2026-09-05T10:30:00.123456Z"
}

Get several documents

Read a list of documents by path in one round trip. Paths that matched nothing are reported separately rather than failing the step.

Inputs

Document pathsdocumentslistRequired: The paths to read, such as users/alice. At most 500 at a time.
Only these fieldsselect_fieldslist: Return just these fields instead of the whole document. Leave empty for everything. Reading fewer fields does not reduce what Firestore charges for the read, but it does keep a large document out of the workflow.

Outputs

countnumber
documentslist
missinglist
missing_countnumber

Example output

{
  "count": 1,
  "documents": [
    {
      "collection": "users",
      "created_time": "2026-09-01T08:00:00.000000Z",
      "fields": {
        "name": "Ada"
      },
      "id": "alice",
      "name": "projects/demo-project/databases/(default)/documents/users/alice",
      "path": "users/alice",
      "updated_time": "2026-09-05T10:30:00.123456Z"
    }
  ],
  "missing": [
    "users/nobody"
  ],
  "missing_count": 1
}

Increment a field

Add to a number stored on a document, atomically. Two workflows doing this at once cannot lose each other's change the way reading and writing back would.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Fieldfield_nametextRequired: Which field to change. A dot means a nested field, so "stats.views" is views inside the stats object.
Addamountnumber: How much to add. Use a negative number to subtract. A field that does not exist yet starts from zero, and a document that does not exist yet is created.Default: 1.

Outputs

fieldtext
pathtext
updated_timetext
value

Example output

{
  "field": "total",
  "path": "counters/visits",
  "updated_time": "2026-09-05T11:10:00.000000Z",
  "value": 129
}

List collections

List the collections at the top of the database, or the subcollections under one document.

Inputs

Under this documentparent_documenttext: Leave empty for the database's root collections, or give a document path such as users/alice to list its subcollections.
Maximum documentslimitnumber: How many documents to return, at most 300. Firestore charges per document read, so keep this to what the workflow will use.From 1 to 300. Default: 25.

Outputs

collectionslist
countnumber
parenttext

Example output

{
  "collections": [
    "users",
    "orders",
    "products"
  ],
  "count": 3,
  "parent": ""
}

List databases

List the Firestore databases in this project, with their locations and editions.

Inputs

None.

Outputs

countnumber
databaseslist
projecttext

Example output

{
  "count": 1,
  "databases": [
    {
      "concurrency_mode": "PESSIMISTIC",
      "created_time": "2026-01-04T09:00:00.000000Z",
      "delete_protection": "DELETE_PROTECTION_DISABLED",
      "edition": "STANDARD",
      "id": "(default)",
      "location": "nam5",
      "name": "projects/demo-project/databases/(default)",
      "point_in_time_recovery": "POINT_IN_TIME_RECOVERY_DISABLED",
      "type": "FIRESTORE_NATIVE",
      "updated_time": "2026-01-04T09:00:00.000000Z"
    }
  ],
  "project": "demo-project"
}

List documents

List the documents in a collection, a page at a time. Use Query documents to filter them.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
Maximum documentslimitnumber: How many documents to return, at most 300. Firestore charges per document read, so keep this to what the workflow will use.From 1 to 300. Default: 25.
Sort by fieldorder_bytext: Which field to sort on. Leave empty to let Firestore return documents in document-id order. A document missing this field is left out of the results entirely - that is Firestore's behaviour for a sorted query, not a bug in the step.
Sort directiondirectiontext: Which way to sort, when a sort field is set.One of: ASCENDING (Ascending (A-Z, 0-9)), DESCENDING. Default: ASCENDING.
Page tokenpage_tokentext: Continue from a previous run: pass the next_page_token that run returned. Leave empty for the first page.
Only these fieldsselect_fieldslist: Return just these fields instead of the whole document. Leave empty for everything. Reading fewer fields does not reduce what Firestore charges for the read, but it does keep a large document out of the workflow.

Outputs

collectiontext
countnumber
documentslist
next_page_tokentext

Example output

{
  "collection": "users",
  "count": 1,
  "documents": [
    {
      "collection": "users",
      "created_time": "2026-09-01T08:00:00.000000Z",
      "fields": {
        "name": "Ada",
        "score": 42
      },
      "id": "alice",
      "name": "projects/demo-project/databases/(default)/documents/users/alice",
      "path": "users/alice",
      "updated_time": "2026-09-05T10:30:00.123456Z"
    }
  ],
  "next_page_token": null
}

Query documents

Find the documents in a collection matching one or more field filters, sorted however you like.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
Filtersfilterslist: Which documents to match. Each filter is a field, an operator and a value - for example {"field": "status", "operator": "EQUAL", "value": "open"}. The four IS_NULL/IS_NOT_NULL/IS_NAN/IS_NOT_NAN operators test the field on their own and take no value; IN, NOT_IN and ARRAY_CONTAINS_ANY take a list. Leave empty to match every document. Filtering or sorting on more than one field needs a composite index - Firestore's error carries a link that creates it.
Combine filters withcombine_filterstext: Whether a document has to match every filter or just one.One of: AND (Match every filter (AND)), OR (Match any filter (OR)). Default: AND.
Sort by fieldorder_bytext: Which field to sort on. Leave empty to let Firestore return documents in document-id order. A document missing this field is left out of the results entirely - that is Firestore's behaviour for a sorted query, not a bug in the step.
Sort directiondirectiontext: Which way to sort, when a sort field is set.One of: ASCENDING (Ascending (A-Z, 0-9)), DESCENDING. Default: ASCENDING.
Maximum documentslimitnumber: How many documents to return, at most 300. Firestore charges per document read, so keep this to what the workflow will use.From 1 to 300. Default: 25.
Skipoffsetnumber: Skip this many matches before returning any. Firestore still reads and charges for the skipped documents, so prefer a tighter filter where you can.At least 0. Default: 0.
Only these fieldsselect_fieldslist: Return just these fields instead of the whole document. Leave empty for everything. Reading fewer fields does not reduce what Firestore charges for the read, but it does keep a large document out of the workflow.
Include subcollections with the same nameinclude_subcollectionstrue/false: Search every collection with this id anywhere in the database, not just the one at this path - Firestore calls it a collection group query. Use it to read, say, every 'comments' subcollection under every post at once.Default: false.

Outputs

collectiontext
countnumber
documentslist

Example output

{
  "collection": "users",
  "count": 1,
  "documents": [
    {
      "collection": "users",
      "created_time": "2026-09-01T08:00:00.000000Z",
      "fields": {
        "active": true,
        "name": "Ada",
        "score": 42
      },
      "id": "alice",
      "name": "projects/demo-project/databases/(default)/documents/users/alice",
      "path": "users/alice",
      "updated_time": "2026-09-05T10:30:00.123456Z"
    }
  ]
}

Remove from an array field

Remove every occurrence of the given values from an array on a document.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Fieldfield_nametextRequired: Which field to change. A dot means a nested field, so "stats.views" is views inside the stats object.
ValuesvalueslistRequired: The values to use. Values are ordinary JSON. For the types JSON has no syntax for, use {"$timestamp": "2026-09-05T10:30:00Z"}, {"$geopoint": {"latitude": 52.5, "longitude": 13.4}}, {"$reference": "users/alice"} or {"$bytes": "<base64>"}.

Outputs

fieldtext
pathtext
updated_timetext
value

Example output

{
  "field": "tags",
  "path": "users/alice",
  "updated_time": "2026-09-05T11:13:00.000000Z",
  "value": null
}

Stamp a field with the server time

Set a field to the moment Firestore applies the write, using Firestore's clock rather than this machine's.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Fieldfield_nametextRequired: Which field to change. A dot means a nested field, so "stats.views" is views inside the stats object.

Outputs

fieldtext
pathtext
updated_timetext
value

Example output

{
  "field": "last_seen",
  "path": "users/alice",
  "updated_time": "2026-09-05T11:15:00.000000Z",
  "value": "2026-09-05T11:15:00.000000Z"
}

Total or average a field

Add up or average a numeric field across the matching documents, without reading them.

Inputs

CollectioncollectiontextRequired: The collection to work in. Pick a root collection, or type a path to reach a subcollection - 'users' or 'users/alice/pets'. A collection path always has an odd number of segments.
CalculateaggregationtextRequired: Which calculation to run over the matches.One of: COUNT (Count the documents), SUM (Add the field up), AVG (Average the field).
Fieldfield_nametext: The numeric field to add up or average. Not needed when counting. Documents where the field is missing or is not a number are skipped.
Filtersfilterslist: Which documents to match. Each filter is a field, an operator and a value - for example {"field": "status", "operator": "EQUAL", "value": "open"}. The four IS_NULL/IS_NOT_NULL/IS_NAN/IS_NOT_NAN operators test the field on their own and take no value; IN, NOT_IN and ARRAY_CONTAINS_ANY take a list. Leave empty to match every document. Filtering or sorting on more than one field needs a composite index - Firestore's error carries a link that creates it.
Combine filters withcombine_filterstext: Whether a document has to match every filter or just one.One of: AND (Match every filter (AND)), OR (Match any filter (OR)). Default: AND.
Include subcollections with the same nameinclude_subcollectionstrue/false: Search every collection with this id anywhere in the database, not just the one at this path - Firestore calls it a collection group query. Use it to read, say, every 'comments' subcollection under every post at once.Default: false.

Outputs

aggregationtext
collectiontext
fieldtext
resultnumber

Example output

{
  "aggregation": "SUM",
  "collection": "orders",
  "field": "total",
  "result": 4820.5
}

Update document

Change some fields on a document that already exists, leaving every other field alone. Fails if the document is not there.

Inputs

Document pathdocumenttextRequired: Which document, as collection/document - 'users/alice'. The path from an earlier Firestore step works as it stands, and so does the full projects/... resource name.
Fields to changefieldsobjectRequired: Only these fields are touched; everything else on the document survives. A dot in a field name means a nested field, so "address.city" writes city inside the address object and leaves the rest of address alone. Setting a field to null stores a null. Values are ordinary JSON. For the types JSON has no syntax for, use {"$timestamp": "2026-09-05T10:30:00Z"}, {"$geopoint": {"latitude": 52.5, "longitude": 13.4}}, {"$reference": "users/alice"} or {"$bytes": "<base64>"}.

Outputs

collectiontext
created_timetext
fieldsobject
idtext
nametext
pathtext
updated_timetext

Example output

{
  "collection": "users",
  "created_time": "2026-09-01T08:00:00.000000Z",
  "fields": {
    "active": true,
    "name": "Ada",
    "score": 43
  },
  "id": "alice",
  "name": "projects/demo-project/databases/(default)/documents/users/alice",
  "path": "users/alice",
  "updated_time": "2026-09-05T11:00:00.000000Z"
}

ActionsCopy Anchor Link

Add to an array fieldCopy Anchor Link

Inputs

Outputs

Count documentsCopy Anchor Link

Inputs

Outputs

Create documentCopy Anchor Link

Inputs

Outputs

Create or update documentCopy Anchor Link

Inputs

Outputs

Create several documentsCopy Anchor Link

Inputs

Outputs

Delete documentCopy Anchor Link

Inputs

Outputs

Delete several documentsCopy Anchor Link

Inputs

Outputs

Empty a collectionCopy Anchor Link

Inputs

Outputs

Get database settingsCopy Anchor Link

Inputs

Outputs

Get documentCopy Anchor Link

Inputs

Outputs

Get several documentsCopy Anchor Link

Inputs

Outputs

Increment a fieldCopy Anchor Link

Inputs

Outputs

List collectionsCopy Anchor Link

Inputs

Outputs

List databasesCopy Anchor Link

Inputs

Outputs

List documentsCopy Anchor Link

Inputs

Outputs

Query documentsCopy Anchor Link

Inputs

Outputs

Remove from an array fieldCopy Anchor Link

Inputs

Outputs

Stamp a field with the server timeCopy Anchor Link

Inputs

Outputs

Total or average a fieldCopy Anchor Link

Inputs

Outputs

Update documentCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add to an array field

Count documents

Create document

Create or update document

Create several documents

Delete document

Delete several documents

Empty a collection

Get database settings

Get document

Get several documents

Increment a field

List collections

List databases

List documents

Query documents

Remove from an array field

Stamp a field with the server time

Total or average a field

Update document