Get sub-account details

GET

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

GET

/v3/corporate/subAccount/:id

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

{
  "companyName": "API-Sub-26thOct21-4",
  "email": "uday+1@brevo.com",
  "groups": [
    {
      "id": "5f8f8c3b5f56a02d4433b3a7",
      "name": "Group 1"
    },
    {
      "id": "5f8f8c3b5f56a02d4433b3a8",
      "name": "Group 2"
    }
  ],
  "name": "Uday Pandit",
  "planInfo": {
    "credits": {
      "emails": {
        "quantity": 2000,
        "remaining": 1955
      },
      "externalFeeds": {
        "quantity": 1,
        "remaining": 1
      },
      "sms": {
        "quantity": 2000,
        "remaining": 1955
      },
      "whatsapp": {
        "quantity": 100,
        "remaining": 50
      },
      "wpSubscribers": {
        "quantity": 2000,
        "remaining": 1955
      }
    },
    "features": {
      "inbox": {
        "quantity": 20,
        "remaining": 12
      },
      "landingPage": {
        "quantity": 25,
        "remaining": 14
      },
      "salesUsers": {
        "quantity": 30,
        "remaining": 14
      },
      "users": {
        "quantity": 30,
        "remaining": 14
      }
    },
    "planType": "paid"
  }
}

This endpoint will provide the details for the specified sub-account company

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.

Path parameters

idlongRequired

Id of the sub-account organization

Response

Sub-account organization details

companyNamestringOptional

Sub-account company name

emailstringOptional

Email id of the sub-account organization

groupslist of objectsOptional

List of groups associated with the sub-account

namestringOptional

Name of the sub-account user

planInfoobjectOptional

Sub-account plan details

Errors

400

Bad Request Error