Sales CRMFiles

Get all files

Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.

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
idstringOptional
Unique file id
namestringOptional
Name of uploaded file
authorIdstringOptional
Account id of user which created the file
contactIdlongOptional
Contact id of contact on which file is uploaded
dealIdstringOptional
Deal id linked to a file
companyIdstringOptional
Company id linked to a file
sizelongOptional
Size of file in bytes
createdAtdatetimeOptional

File created date/time

Errors

400
Bad Request Error