Files

Get all files

get/crm/files

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/crm/files
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Query parameters

entity'companies' | 'deals' | 'contacts'

Filter by file entity type

entityIdsstring

Filter by file entity IDs

dateFrominteger

dateFrom to date range filter type (timestamp in milliseconds)

dateTointeger

dateTo to date range filter type (timestamp in milliseconds)

offsetinteger

Index of the first document of the page

limitinteger

Number of documents per page

sort'asc' | 'desc'

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

Response

Returns files list with filters

namestring

Name of uploaded file

authorIdstring

Account id of user which created the file

contactIdinteger

Contact id of contact on which file is uploaded

dealIdstring

Deal id linked to a file

companyIdstring

Company id linked to a file

sizeinteger

Size of file in bytes

createdAtstring date-time

File created date/time

Example response

[
  {
    "createdAt": "2017-05-01T17:05:03.000Z",
    "companyId": "61a5ce58c5d4795761045991",
    "size": 10,
    "contactId": 1,
    "dealId": "61a5ce58c5d4795761045991",
    "name": "example.png",
    "authorId": "61a5ce58y5d4795761045991"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.