Retrieve files

Retrieves a list of files.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

fields
string

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of files retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

name
string

Original file name.

extension
string

File extension.

description
string

Description of the file.

sourceType
string or null

Source of the file.

Enum: "upload" "camera" "organization-export" "organization-closure-export"
tags
Array of strings

List of tags associated with the file.

mime
string

MIME type of the file.

Enum: "image/png" "image/jpeg" "image/gif" "application/pdf"
size
integer

File size, in bytes.

width
integer

Image width. This field applicable to images only.

height
integer

Image height. This field applicable to images only.

sha1
string

Hash sum of the file.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

isPublic
boolean

Specifies if the file is available publicly without authentication. If this value is true, the permalink in the _links section contains the public URL.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "download" "signedLink" "permalink"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/files
Request samples
$files = $client->files()->search([
    'filter' => 'name:TestFile',
]);
Response samples
application/json
[
  • {
    }
]