Method: projects.databases.documents.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource name. In the format: projects/{projectId}/databases/{databaseId}/documents or projects/{projectId}/databases/{databaseId}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
|
collectionId |
string
Optional. The collection ID, relative to parent, to list. For example: chatrooms or messages. This is optional, and when not provided, Firestore will list documents from all collections under the provided parent.
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
|
pageToken |
string
Optional. A page token, received from a previous documents.list response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of pageSize) must match the values set in the request that generated the page token.
|
orderBy |
string
Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc. This mirrors the ORDER BY__name__ ASC.
|
mask |
object (DocumentMask)
Optional. The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
|
showMissing |
boolean
If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, createTimeupdateTime Requests with showMissing may not specify where or orderBy.
|
Union parameter consistency_selector. The consistency mode for this transaction. If not set, defaults to strong consistency. consistency_selector can be only one of the following: |
transaction |
string (bytes format)
Perform the read as part of an already active transaction. A base64-encoded string.
|
readTime |
string (Timestamp format)
Perform the read at the provided 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".
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListDocumentsResponse.
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.list\n\nLists documents.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}`\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 resource name. In the format: `projects/{projectId}/databases/{databaseId}/documents` or `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` |\n| `collectionId` | `string` Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. |\n\n### Query parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. |\n| `pageToken` | `string` Optional. A page token, received from a previous `documents.list` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `pageSize`) must match the values set in the request that generated the page token. |\n| `orderBy` | `string` Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the [`ORDER BY`](/docs/firestore/reference/rest/v1/StructuredQuery#FIELDS.order_by) used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`. |\n| `mask` | `object (`[DocumentMask](/docs/firestore/reference/rest/v1/DocumentMask)`)` Optional. The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. |\n| `showMissing` | `boolean` If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, [`createTime`](/docs/firestore/reference/rest/v1/projects.databases.documents#Document.FIELDS.create_time), or [`updateTime`](/docs/firestore/reference/rest/v1/projects.databases.documents#Document.FIELDS.update_time) set. Requests with `showMissing` may not specify `where` or `orderBy`. |\n| Union parameter `consistency_selector`. The consistency mode for this transaction. If not set, defaults to strong consistency. `consistency_selector` can be only one of the following: ||\n| `transaction` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` Perform the read as part of an already active transaction. A base64-encoded string. |\n| `readTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Perform the read at the provided 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### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListDocumentsResponse](/docs/firestore/reference/rest/v1/ListDocumentsResponse).\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)."]]
