List all consent groups

GET

https://api.brevo.com/v3/contacts/consent-groups

Returns a paginated list of consent groups for the account.

This endpoint is only available when the Consent Groups feature is enabled for your account. Returns 403 if the feature is not activated.

Returns a paginated list of consent groups for the account. <Note>This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated.</Note>

Authentication

api-keystring

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

Query parameters

limitlongOptional0-50Defaults to 10

Maximum number of results to return (default 10, max 50)

offsetlongOptional>=0Defaults to 0

Number of results to skip (default 0)

idlongOptional

Filter by consent group ID

namestringOptional

Filter by name (case-insensitive partial match)

signupModeenumOptional

Filter by signup mode

Allowed values:

Response

Paginated list of consent groups

consentGroupslist of objects

List of consent groups matching the filter

totallong

Total number of consent groups matching the filter

limitlong

Maximum number of results returned

offsetlong

Number of results skipped

Errors

400

Bad Request Error

403

Forbidden Error

429

Too Many Requests Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.consentGroups.getConsentGroups({});
8	}
9	main();

1	{
2	"consentGroups": [
3	{
4	"id": 1,
5	"name": "Newsletter EU",
6	"signupMode": "manual",
7	"contactsCount": 1234,
8	"isDefault": false,
9	"createdAt": "2024-01-15T10:00:00Z",
10	"updatedAt": "2024-06-01T08:30:00Z",
11	"description": "Consent group for EU newsletter subscribers"
12	}
13	],
14	"total": 1,
15	"limit": 10,
16	"offset": 0
17	}