Get lists in a folder | Brevo API Documentation

Ongoing changes for this endpoint.

We’re dropping support for the response attributes totalSubscribers and totalBlacklisted.

These are non breaking changes. The default value for the attributes will be 0.

<Note> Ongoing changes for this endpoint. We're dropping support for the response attributes totalSubscribers and totalBlacklisted. These are non breaking changes. The default value for the attributes will be 0. </Note>

Authentication

api-keystring

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

Path parameters

folderIdlongRequired

Id of the folder

Query parameters

limitlongOptionalDefaults to 10

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

Folder's Lists details

countlong or null

Number of lists in the folder

listslist of objects or null

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

1	{
2	"count": 3,
3	"lists": [
4	{
5	"id": 46,
6	"name": "Reactiv",
7	"totalBlacklisted": 0,
8	"totalSubscribers": 7655,
9	"uniqueSubscribers": 7655
10	},
11	{
12	"id": 41,
13	"name": "NY_Area",
14	"totalBlacklisted": 23,
15	"totalSubscribers": 3654,
16	"uniqueSubscribers": 3677
17	},
18	{
19	"id": 22,
20	"name": "VIP_Customer",
21	"totalBlacklisted": 72,
22	"totalSubscribers": 8753,
23	"uniqueSubscribers": 8826
24	}
25	]
26	}

Authentication

Path parameters

Query parameters

Response

Errors