API Reference

Get all the contacts

get
https://api.brevo.com/v3/contacts
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
0 to 1000
Defaults to 50

Number of documents per page

int64
Defaults to 0

Index of the first document of the page

string

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.

string

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.

string
enum
Defaults to desc

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

Allowed:
int64

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

listIds
array of int64s

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

listIds
string

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")

Responses

Updated 11 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago