Get the list of all the sub-accounts of the master account.

GET

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

GET

/v3/corporate/subAccount

1 import { BrevoApiClient } from "brevo";
2 
3 const client = new BrevoApiClient({ apiKey: "YOUR_API_KEY", partnerKey: "YOUR_PARTNER_KEY" });
4 await client.get.corporateSubAccounts({
5     offset: 1,
6     limit: 1
7 });

Try it

1 {
2   "count": 3,
3   "subAccounts": [
4     {
5       "active": true,
6       "companyName": "Company1",
7       "createdAt": 1631523176,
8       "groups": [
9         {
10           "id": "5f8f8c3b5f56a02d4433b3a8",
11           "name": "Group 1"
12         },
13         {
14           "id": "4fbf3c3b1f56a02ac465b1a0",
15           "name": "Group 2"
16         }
17       ],
18       "id": 4043629
19     },
20     {
21       "active": true,
22       "companyName": "Company2",
23       "createdAt": 1629439311,
24       "groups": [],
25       "id": 3984002
26     },
27     {
28       "active": true,
29       "companyName": "Company3",
30       "createdAt": 1614713641,
31       "groups": [],
32       "id": 3524191
33     }
34   ]
35 }

This endpoint will provide the list all the sub-accounts of the master account.

Authentication

api-keystring

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

Query parameters

offsetintegerRequired

Index of the first sub-account in the page

limitintegerRequired

Number of sub-accounts to be displayed on each page

Response

Sub-accounts list

countinteger or null

Total number of subaccounts

subAccountslist of objects or null

Authentication

Query parameters

Response

Errors