/files

get

https://{BaseUrl}/api/v3.0/files

Returns a list of archived items.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort

array of strings

Defaults to +createTimestamp

List of fields that should be sorted. Use "-" and the field name to specify descending results. Use "+" and the field name to specify ascending results. By default, results are sorted by create timestamp in ascending order.

sort

mimeType

string

Exact content type.

mimeType__contains

string

Content type contains filter.

createTimestamp__lte

string

Maximum timestamp for file creation date.

createTimestamp__gte

string

Minimum timestamp for file creation date.

directory

string

Name of parent directory.

directory__contains

string

Item directory contains filter.

name

string

Exact name of the item.

name__contains

string

length between 1 and 128

File name contains filter.

notes__contains

string

Notes filter.

size__lte

string

Maximum file size.

size__gte

string

Minimum file size.

include

array of strings

The fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. You can use the special value * during development to return all fields, however, to achieve better performance, it is advisable to explicitly select only the fields you need.

include

pageToken

string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSize

integer

1 to 500

Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Responses

200OK

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

500Something went wrong in the server. Please try again.