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");
}
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.

Path parameters

idstringRequired

Id of the group of sub-organization

Response

Group details

groupobject

sub-accountslist of objects

userslist 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.getAGroupDetails("id");
8	}
9	main();

1	{
2	"group": {
3	"createdAt": "2024-02-09T06:14:40+00:00",
4	"groupName": "My group",
5	"id": "5f926dba72a405440a4efc97"
6	},
7	"sub-accounts": [
8	{
9	"companyName": "My sub organization",
10	"createdAt": "2024-02-09T06:14:40+00:00",
11	"id": 7866556
12	},
13	{
14	"companyName": "Your sub organization",
15	"createdAt": "2024-01-05T03:11:40+00:00",
16	"id": 6563051
17	}
18	],
19	"users": [
20	{
21	"email": "my-user@my-org.com",
22	"firstName": "John",
23	"lastName": "Smith"
24	},
25	{
26	"email": "your-user@your-org.com"
27	}
28	]
29	}