List of files

GET

Getting a paginated list of files. If you need multiple results pages, use previous/next from the response to navigate back/forth.

Headers

AcceptstringOptional
Version header.

Query parameters

removedbooleanOptional

true to only include removed files in the response, false to include existing files. Defaults to false.

storedbooleanOptional

true to only include files that were stored, false to include temporary ones. The default is unset: both stored and not stored files are returned.

limitdoubleOptional
A preferred amount of files in a list for a single response. Defaults to 100, while the maximum is 1000.
ordering"datetime_uploaded" or "-datetime_uploaded"OptionalDefaults to datetime_uploaded

Specifies the way files are sorted in a returned list. datetime_uploaded for ascending order, -datetime_uploaded for descending order.

Allowed values: datetime_uploaded-datetime_uploaded
fromstringOptional

A starting point for filtering the files. If provided, the value MUST adhere to the ISO 8601 Extended Date/Time Format (YYYY-MM-DDTHH:MM:SSZ).

includestringOptional
Include additional fields to the file object, such as: appdata.

Response

This endpoint returns an object.
nextstringOptional
Next page URL.
previousstringOptional
Previous page URL.
totaldoubleOptional
Total number of the files of the queried type. The queried type depends on the stored and removed query parameters.
totalsobjectOptional
per_pagedoubleOptional
Number of the files per page.
resultslist of objectsOptional

Errors

Built with