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: |
collectionId |
Required. The collection ID, relative to |
Query parameters
Parameters | ||
---|---|---|
pageSize |
The maximum number of documents to return. |
|
pageToken |
The |
|
orderBy |
The order to sort results by. For example: |
|
mask |
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 missing document is a document that does not exist but has sub-documents. These 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 |
Reads documents in a transaction. A base64-encoded string. |
|
readTime |
Reads documents as they were at the given time. This may not be older than 60 seconds. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
The response for Firestore.ListDocuments
.
JSON representation | |
---|---|
{
"documents": [
{
object ( |
Fields | |
---|---|
documents[] |
The Documents found. |
nextPageToken |
The next page token. |
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.