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

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.masterAccount.getTheListOfAllTheSubAccountsOfTheMasterAccount({
        offset: 1,
        limit: 1,
    });
}
main();

{
  "count": 3,
  "subAccounts": [
    {
      "active": true,
      "companyName": "Company1",
      "createdAt": 1631523176,
      "groups": [
        {
          "id": "5f8f8c3b5f56a02d4433b3a8",
          "name": "Group 1"
        },
        {
          "id": "4fbf3c3b1f56a02ac465b1a0",
          "name": "Group 2"
        }
      ],
      "id": 4043629
    },
    {
      "active": true,
      "companyName": "Company2",
      "createdAt": 1629439311,
      "groups": [],
      "id": 3984002
    },
    {
      "active": true,
      "companyName": "Company3",
      "createdAt": 1614713641,
      "groups": [],
      "id": 3524191
    }
  ]
}

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

Total number of subaccounts

subAccountslist of objects

Errors

400

Bad Request 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.masterAccount.getTheListOfAllTheSubAccountsOfTheMasterAccount({
8	offset: 1,
9	limit: 1,
10	});
11	}
12	main();

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	}