API Documentation

List Files

GET/vimoo/api/v1/files

AuthorizationHeader · RequiredGet an API Key ↗

Retrieve a paginated list of files for the current account, with filters for file type, tag, and file name.

offsetintegerNo: Non-negative pagination offset; defaults to 0
limitintegerNo: Number of items per page, from 1 to 100; defaults to 20
file_typeintegerNo: Filter by file type. Values:
1 (FILE_TYPE_INPUT_IMAGE): Uploaded image asset
2 (FILE_TYPE_GENERATED_VIDEO): Generated video
Omit to return all types
tagstringNo: Filter by an exact tag, up to 64 characters
file_namestringNo: Filter by file name
sort_by_fieldstringNo: Sort field: time (creation time) or name (file name). Defaults to creation time
sort_by_orderstringNo: Sort order: asc (ascending) or desc (descending). Defaults to descending

filesarray[object]: Files sorted by creation time in descending order. See Get File Details for item fields. Returns an empty array when no files match
totalinteger: Total number of files matching the current filters

Example successful response (excerpt):

See Responses and Error Codes for error response formats and error codes.