Return all your categories | Brevo API Documentation

Authentication

api-keystring

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

Query parameters

limitlongOptionalDefaults to 50

Number of documents per page

offsetlongOptionalDefaults to 0

Index of the first document in 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:

idslist of stringsOptional

Filter by category ids

namestringOptional

Filter by category name

modifiedSincestringOptional

Filter (urlencoded) the categories 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.

createdSincestringOptional

Filter (urlencoded) the categories 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.

isDeletedstringOptional

Filter categories by their deletion status. If false is passed, only categories that are not deleted will be returned.

Response

All categories listed

categorieslist of objects

countlong

Number of categories

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

1	{
2	"categories": [
3	{
4	"createdAt": "2021-12-31T11:42:35.638Z",
5	"id": "C19",
6	"isDeleted": true,
7	"modifiedAt": "2022-03-03T14:48:31.867Z",
8	"name": "Food",
9	"url": "http://mydomain.com/category/food"
10	},
11	{
12	"createdAt": "2021-12-31T11:42:35.638Z",
13	"id": "C20",
14	"isDeleted": true,
15	"modifiedAt": "2022-03-03T14:48:31.867Z",
16	"name": "clothing",
17	"url": "http://mydomain.com/category/clothing"
18	}
19	],
20	"count": 2
21	}

Authentication

Query parameters

Response

Errors