GET a group details | Brevo API Documentation

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

{
  "group": {
    "createdAt": "2024-02-09T06:14:40+00:00",
    "groupName": "My group",
    "id": "5f926dba72a405440a4efc97"
  },
  "sub-accounts": [
    {
      "companyName": "My sub organization",
      "createdAt": "2024-02-09T06:14:40+00:00",
      "id": 7866556
    },
    {
      "companyName": "Your sub organization",
      "createdAt": "2024-01-05T03:11:40+00:00",
      "id": 6563051
    }
  ],
  "users": [
    {
      "email": "my-user@my-org.com",
      "firstName": "John",
      "lastName": "Smith"
    },
    {
      "email": "your-user@your-org.com"
    }
  ]
}

This endpoint allows you to retrieve a specific group’s information such as the list of sub-organizations and the user associated with the group.

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

idstringRequired

Id of the group of sub-organization

Response

Group details

groupobjectOptional

sub-accountslist of objectsOptional

userslist of objectsOptional

Errors

400

Bad Request Error