Required. The parent document. In the format: projects/{projectId}/databases/{databaseId}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
Request body
The request body contains data with the following structure:
JSON representation
{"pageSize": integer,"pageToken": string,// Union field consistency_selector can be only one of the following:"readTime": string// End of list of possible types for union field consistency_selector.}
Union field consistency_selector. The consistency mode for this request. If not set, defaults to strong consistency. consistency_selector can be only one of the following:
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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis endpoint, using a POST request, retrieves a list of collection IDs found under a specified document in Firestore.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter, which is required, defines the document path in the format: \u003ccode\u003eprojects/{projectId}/databases/{databaseId}/documents/{document_path}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body allows specifying \u003ccode\u003epageSize\u003c/code\u003e to limit the number of results, a \u003ccode\u003epageToken\u003c/code\u003e to retrieve specific pages, and \u003ccode\u003ereadTime\u003c/code\u003e to obtain a snapshot of the data at a given point in time.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003ecollectionIds\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination if more results are available.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/datastore\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["Lists all the collection IDs underneath a document.\n\nHTTP request\n\n`POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent document. In the format: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` |\n\nRequest body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"pageSize\": integer, \"pageToken\": string, // Union field `consistency_selector` can be only one of the following: \"readTime\": string // End of list of possible types for union field `consistency_selector`. } ``` |\n\n| Fields ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results to return. |\n| `pageToken` | `string` A page token. Must be a value from [ListCollectionIdsResponse](/firestore/docs/reference/rest/v1/projects.databases.documents/listCollectionIds#body.ListCollectionIdsResponse). |\n| Union field `consistency_selector`. The consistency mode for this request. If not set, defaults to strong consistency. `consistency_selector` can be only one of the following: ||\n| `readTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Reads documents as they were 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: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n\nResponse body The response from [Firestore.ListCollectionIds](/firestore/docs/reference/rest/v1/projects.databases.documents/listCollectionIds#google.firestore.v1.Firestore.ListCollectionIds).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------|\n| ``` { \"collectionIds\": [ string ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------|\n| `collectionIds[]` | `string` The collection ids. |\n| `nextPageToken` | `string` A page token that may be used to continue the list. |\n\nAuthorization 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 [Authentication Overview](/docs/authentication#authorization-gcp)."]]
