Lists documents.
HTTP request
GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent resource name. In the format: For example: |
collectionId |
Optional. The collection ID, relative to For example: This is optional, and when not provided, Firestore will list documents from all collections under the provided |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. |
pageToken |
Optional. A page token, received from a previous Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of |
orderBy |
Optional. The optional ordering of the documents to return. For example: This mirrors the |
mask |
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 |
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, Requests with |
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 |
Perform the read as part of an already active transaction. A base64-encoded string. |
readTime |
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. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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/datastore
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.