v1

latestOpenAPI 3.0.12026-07-14182037.3 KB
Files

Search files

Search through files in the file manager. Does not display hidden or archived files.

get/files/v3/files/search

Query parameters

propertiesstring[]

Desired file properties in the return object.

afterstring

The maximum offset of items for a given search is 10000. Narrow your search down if you are reaching this limit.

beforestring
limitinteger

Number of items to return. Maximum limit is 100.

sortstring[]

Sort files by a given field.

idstring

Search files by given ID.

createdAtstring date-time

Search files by time of creation.

createdAtLtestring date-time
createdAtGtestring date-time
updatedAtstring date-time

Search files by time of latest updated.

updatedAtLtestring date-time
updatedAtGtestring date-time
namestring

Search for files containing the given name.

pathstring

Search files by path.

parentFolderIdinteger

Search files within given folder ID.

sizeinteger

Query by file size.

heightinteger

Search files by height of image or video.

widthinteger

Search files by width of image or video.

encodingstring

Search files with specified encoding.

typestring

Filter by provided file type.

extensionstring

Search files by given extension.

urlstring

Search for given URL

isUsableInContentboolean

If true shows files that have been marked to be used in new content. It false shows files that should not be used in new content.

allowsAnonymousAccessboolean

If 'true' will show private files; if 'false' will show public files

Response

successful operation