List the org's files

Returns one page of the org's file library, newest first, with the org's standing usage against its storage quota. Every file carries its source (upload or capture) and, for a capture, its surface and capture state. Filter with source, surface and session_id. Files persist until deleted and any ready file can be delivered to a phone the org holds.

limitinteger

max items per page

offsetinteger

pagination offset

qstring

filter by filename, case-insensitive substring match

source'upload' | 'capture'

only files of this source

surface'phone'

only captures off this surface

session_idstring uuid

only files captured by this session

mime_typestring

only files of exactly this media type

min_size_bytesinteger

only files at least this many bytes (0 = no bound)

max_size_bytesinteger

only files at most this many bytes (0 = no bound)

created_afterstring date-time

only files registered at or after this time (RFC 3339)

created_beforestring date-time

only files registered at or before this time (RFC 3339)

sort'created_at' | 'filename' | 'size_bytes' | 'source'

field to sort by; source groups uploads and captures

order'asc' | 'desc'

sort direction

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total files matching the query.

Example response

{
  "$schema": "/api/v1/FileListResponse.json"
}

List the org's files

Query parameters

Response

Example response

Changes