Method: projects.databases.documents.listCollectionIds
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the collection IDs underneath a document.
HTTP request
POST https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents}:listCollectionIds
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
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
|
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.
} |
| Fields |
pageSize |
integer
The maximum number of results to return.
|
pageToken |
string
A page token. Must be a value from ListCollectionIdsResponse.
|
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: |
readTime |
string (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 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".
|
Response body
The response from Firestore.ListCollectionIds.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"collectionIds": [
string
],
"nextPageToken": string
} |
| Fields |
collectionIds[] |
string
The collection ids.
|
nextPageToken |
string
A page token that may be used to continue the list.
|
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.listCollectionIds\n\nLists all the collection IDs underneath a document.\n\n### HTTP 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\n### Path 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\n### Request 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](/docs/firestore/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 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### Response body\n\nThe response from [Firestore.ListCollectionIds](/docs/firestore/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\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)."]]
