Get all files

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

entityenumOptional
Filter by file entity type
Allowed values:
entityIdsstringOptional
Filter by file entity IDs
dateFromintegerOptional

dateFrom to date range filter type (timestamp in milliseconds)

dateTointegerOptional

dateTo to date range filter type (timestamp in milliseconds)

offsetlongOptional
Index of the first document of the page
limitlongOptionalDefaults to 50
Number of documents per page
sortenumOptional

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

Allowed values:

Response

Returns files list with filters
authorIdstring or null
Account id of user which created the file
companyIdstring or null
Company id linked to a file
contactIdlong or null
Contact id of contact on which file is uploaded
createdAtdatetime or null

File created date/time

dealIdstring or null
Deal id linked to a file
namestring or null
Name of uploaded file
sizelong or null
Size of file in bytes

Errors