For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Help Center API Keys Status Sign In

Guides API Reference Changelog

Accounts and Settings Master Account

Get the list of groups

GET

https://api.brevo.com/v3/corporate/groups

GET

/v3/corporate/groups

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.masterAccount.getSubAccountGroups();
8 }
9 main();

1 [
2   {
3     "groupName": "My group 1",
4     "id": "d3b142c709d6ed67ef1cd903"
5   },
6   {
7     "groupName": "My group 2",
8     "id": "a5b192a709d6ed67ef8fd922"
9   },
10   {
11     "groupName": "My group 3",
12     "id": "bbb142c709d6ed67ef1cd910"
13   }
14 ]

This endpoint allows you to list all groups created on your Admin account.

Was this page helpful?

Get the list of all your users

Guides API Reference Changelog

Introduction
- Getting started
Email API
Transactional SMS
Transactional WhatsApp
Marketing Campaigns
Contact Management
Events
Object Management
Accounts and Settings
Sales CRM
Conversations
Ecommerce
Loyalty

Help Center API Keys Status Sign In

Authentication

api-keystring

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

Response

list of all the sub-account groups

groupNamestring

The name of the group of sub-accounts

idstring

Unique id of the group

Errors

400

Bad Request Error