Get contacts in a list | Brevo API Documentation

1 import requests 2 3 url = "https://api.brevo.com/v3/contacts/lists/1/contacts" 4 5 headers = {"api-key": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "contacts": [ 3 { 4 "attributes": { 5 "DOB": "2010-12-31", 6 "FIRSTNAME": "Alex", 7 "GENDER": "Kid", 8 "LASTNAME": "Pain" 9 }, 10 "createdAt": "2017-05-12T12:30:00Z", 11 "emailBlacklisted": false, 12 "id": 45, 13 "listIds": [ 14 12, 15 9, 16 20 17 ], 18 "modifiedAt": "2017-05-12T12:30:00Z", 19 "smsBlacklisted": true, 20 "email": "alex.pain@example.com", 21 "listUnsubscribed": [ 22 1, 23 2 24 ] 25 }, 26 { 27 "attributes": { 28 "DOB": "1986-06-21", 29 "FIRSTNAME": "John", 30 "GENDER": "Men", 31 "LASTNAME": "Smith" 32 }, 33 "createdAt": "2017-05-12T12:30:00Z", 34 "emailBlacklisted": true, 35 "id": 32, 36 "listIds": [ 37 12 38 ], 39 "modifiedAt": "2017-05-12T12:30:00Z", 40 "smsBlacklisted": false, 41 "email": "john.smith@example.com", 42 "listUnsubscribed": [ 43 1 44 ] 45 }, 46 { 47 "attributes": { 48 "DOB": "1988-11-02", 49 "FIRSTNAME": "Helen", 50 "GENDER": "Women", 51 "LASTNAME": "Rose", 52 "SMS": "3375599887766" 53 }, 54 "createdAt": "2017-05-12T12:30:00Z", 55 "emailBlacklisted": true, 56 "id": 65, 57 "listIds": [ 58 12, 59 9, 60 20 61 ], 62 "modifiedAt": "2017-05-12T12:30:00Z", 63 "smsBlacklisted": false, 64 "email": "helen.rose@example.com", 65 "listUnsubscribed": [ 66 1 67 ] 68 } 69 ], 70 "count": 17655 71 }

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

listIdlongRequired

Id of the list

Query parameters

modifiedSincestringOptional

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.

limitlongOptionalDefaults to 50

Number of documents per page

offsetlongOptionalDefaults to 0

Index of the first document of the page

sortenumOptionalDefaults to desc

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

Allowed values:

Response

Contact informations

contactslist of objects

countlong

Number of contacts

Authentication

Path parameters

Query parameters

Response

Errors