contacts

Get all the contacts

Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.

get/contacts

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts
  • Auth: API key in header api-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

idsinteger[]

Filter by a list of contact IDs. You can pass a maximum of 20 IDs. All elements must be integers.

segmentIdinteger

Id of the segment. Either listIds or segmentId can be passed. Must be a positive integer (minimum value of 1).

listIdsinteger[]

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

filterstring

Filter the contacts on the basis of attributes. Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter=equals(FIRSTNAME,"Antoine"), filter=equals(B1, true), filter=equals(DOB, "1989-11-23"), filter=equals(GENDER, "1"), filter=equals(GENDER, "MALE"), filter=equals(COUNTRY,"USA, INDIA")

Response

All contacts listed

countinteger required

Number of contacts

Changes

No recorded changes to this operation across all 1 revision of this API.