Contacts

Get all the contacts

Changed on
get/contacts

Request

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

Query parameters

limitinteger

Number of documents per page

offsetinteger

Index of the first document of the page

modifiedSincestring

Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

createdSincestring

Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

sort'asc' | 'desc'

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

segmentIdinteger

Id of the segment. Either listIds or segmentId can be passed.

listIdsinteger[]

Ids of the list. Either listIds or segmentId can be passed.

filterstring

Filter the contacts on the basis of attributes. Allowed operator: equals. (e.g. filter=equals(FIRSTNAME,"Antoine"), filter=equals(B1, true), filter=equals(DOB, "1989-11-23"))

Response

All contacts listed

countinteger required

Number of contacts

Example response

{
  "contacts": [
    {
      "email": "john.smith@example.com",
      "id": 32,
      "smsBlacklisted": true,
      "createdAt": "2017-05-12T12:30:00Z",
      "modifiedAt": "2017-05-12T12:30:00Z",
      "attributes": {
        "name": "Joe",
        "email": "joe@example.com"
      }
    }
  ],
  "count": 17655
}

Changes

  • 2aec3cf66501Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter listIds

    • info

      added the new optional query request parameter segmentId

  • 2122e9ffdbe8Revision changes
    • warning

      deleted the query request parameter filter

    • warning

      deleted the query request parameter listIds

    • warning

      deleted the query request parameter segmentId