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({
        limit: 1,
        offset: 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.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

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

countintegerOptional

Total number of subaccounts

subAccountslist of objectsOptional

Errors

400

Bad Request Error