Returns a folder's details | Brevo API Documentation

<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>

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.

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

Response

Folder details

idlong

ID of the folder

namestring

Name of the folder

totalBlacklistedlong

Number of blacklisted contacts in the folder

totalSubscriberslong

Number of contacts in the folder

uniqueSubscriberslong

Number of unique contacts in the folder

Errors

400

Bad Request Error

404

Not Found Error

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

Number of blacklisted contacts in the folder

Number of contacts in the folder

Number of unique contacts in the folder

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.contacts.getFolder(1);
8	}
9	main();

1	{
2	"id": 1,
3	"name": "Client_Folder",
4	"totalBlacklisted": 987,
5	"totalSubscribers": 16778,
6	"uniqueSubscribers": 17765
7	}

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.contacts.getFolder(1);
8	}
9	main();

1	{
2	"id": 1,
3	"name": "Client_Folder",
4	"totalBlacklisted": 987,
5	"totalSubscribers": 16778,
6	"uniqueSubscribers": 17765
7	}