younifyd
Menu

Firestore.projects.databases.documents.list Collection Ids

Lists all the collection IDs underneath a document.

POST/v1/{parent}:listCollectionIds

Use it in a workflow

  1. Add a step and choose the Firestore connector.
  2. Pick the Firestore.projects.databases.documents.list Collection Ids action (under projects).
  3. Fill in the fields below, then reference the result from later steps as {{firestoreProjectsDatabasesDocumentsListCollectionIds.response.data}}.

Request

Path parameters

parentstringrequired

Required. The parent document. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

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.

pageSizeinteger (int32)

The maximum number of results to return.

pageTokenstring

A page token. Must be a value from ListCollectionIdsResponse.

readTimestring (google-datetime)

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

json
{
  "pageSize": 0,
  "pageToken": "string",
  "readTime": "string"
}

Response

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

collectionIdsarray<string>

The collection ids.

nextPageTokenstring

A page token that may be used to continue the list.

json
{
  "collectionIds": [
    "string"
  ],
  "nextPageToken": "string"
}

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