Get all folders | 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.

The uniqueSubscribers field is deprecated

<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. The uniqueSubscribers field is deprecated </Note>

Authentication

api-keystring

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

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

Folders informations

countlong or null

Number of folders available in your account

folderslist of objects or null

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

1	{
2	"count": 2,
3	"folders": [
4	{
5	"id": 42,
6	"name": "Ninja_Form",
7	"totalBlacklisted": 98,
8	"totalSubscribers": 4567,
9	"uniqueSubscribers": 4665
10	},
11	{
12	"id": 29,
13	"name": "Prestashop",
14	"totalBlacklisted": 10,
15	"totalSubscribers": 6543,
16	"uniqueSubscribers": 6553
17	}
18	]
19	}

Authentication

Query parameters

Response

Errors