firestore.projects.databases.documents.list
GET {{baseUrl}}/v1/:parent/:collectionId?mask.fieldPaths=<string>&mask.fieldPaths=<string>&orderBy=<string>&pageSize=<integer>&pageToken=<string>&readTime=<string>&showMissing=<boolean>&transaction=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists documents.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
mask.fieldPaths | string | The list of field paths in the mask. See Document.fields for a field path syntax reference. | |
mask.fieldPaths | string | The list of field paths in the mask. See Document.fields for a field path syntax reference. | |
orderBy | string | The order to sort results by. For example: priority desc, name. | |
pageSize | string | The maximum number of documents to return. | |
pageToken | string | The next_page_token value returned from a previous List request, if any. | |
readTime | string | Reads documents as they were at the given time. This may not be older than 270 seconds. | |
showMissing | string | 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, Document.create_time, or Document.update_time set. Requests with show_missing may not specify where or order_by. | |
transaction | string | Reads documents in a transaction. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"documents":[{"createTime":"\u003cstring\u003e","fields":"\u003cobject\u003e","name":"\u003cstring\u003e","updateTime":"\u003cstring\u003e"},{"createTime":"\u003cstring\u003e","fields":"\u003cobject\u003e","name":"\u003cstring\u003e","updateTime":"\u003cstring\u003e"}],"nextPageToken":"pariatur do culpa reprehenderit"}