GET /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.
Servers
- https://api.brevo.com/v3
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
createdSince |
String | No |
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. |
limit |
Integer | No |
Number of documents per page Default value: 50 |
modifiedSince |
String | No |
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. |
filter |
String | No |
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") |
sort |
String | No |
Sort the results in the ascending/descending order of record creation. Default order is descending if Valid values:
Default value: "desc" |
listIds[] |
Array | No |
Ids of the list. Either listIds or segmentId can be passed. |
segmentId |
Integer | No |
Id of the segment. Either listIds or segmentId can be passed. Must be a positive integer (minimum value of 1). |
ids[] |
Array | No |
Filter by a list of contact IDs. You can pass a maximum of 20 IDs. All elements must be integers. |
offset |
Integer | No |
Index of the first document of the page Default value: 0 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.