Skip to navigation
API ReferenceInboxesFiles

List Files

Beta

Lists the inbox’s files in path order, pending ones included, optionally only those whose path starts with path_prefix. A prefix matches characters, not whole segments: reports/q matches reports/q3.pdf. Items carry no download URL; get a file for one.

The list is read in the region that serves the request, so a file created or deleted a moment ago may not show yet. Expired files never show.

Requires the file_read permission.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.

Query parameters

path_prefixstringOptional
Only files whose path starts with this. Held to the path rules, except it may stop partway.
limitintegerOptional
Page size, 100 by default and at most 500.
page_tokenstringOptional
Page token for pagination.
ascendingbooleanOptional

Path order, true by default. false lists in reverse.

Response

This endpoint returns an object.
countinteger
Number of items returned.
limitinteger
Limit of number of items returned.
fileslist of objects

The inbox’s files in path order. A list has no download URLs; get a file for one.

next_page_tokenstringOptional
Page token for pagination.

Errors

400
Validation Error
403
File Forbidden Error
404
Not Found Error