Get account details | Brevo API Documentation

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

{
  "organization_id": "5fa2b8c123456789abcdef01",
  "user_id": 1234567,
  "enterprise": false,
  "companyName": "Acme Marketing Corp",
  "email": "michael.davis@example.com",
  "firstName": "Michael",
  "lastName": "Davis",
  "plan": [
    {
      "credits": 250,
      "creditsType": "sendLimit",
      "type": "free"
    },
    {
      "credits": 15,
      "creditsType": "sendLimit",
      "type": "sms"
    }
  ],
  "relay": {
    "data": {
      "port": 587,
      "relay": "smtp-relay.brevo.com",
      "userName": "michael.davis@example.com"
    },
    "enabled": true
  },
  "address": {
    "city": "New York",
    "country": "United States",
    "street": "456 Business Ave",
    "zipCode": "10001"
  },
  "marketingAutomation": {
    "enabled": true,
    "key": "ma8k2x9v4h7p3d6f1c5e8b2a"
  },
  "planVerticals": [
    {
      "planCategory": "Marketing",
      "planType": "free",
      "name": "Free",
      "status": "active",
      "startDate": "1751234567",
      "endDate": "1753826567",
      "users": {
        "purchasedSeats": "1",
        "usedSeats": "1"
      },
      "credits": "250"
    },
    {
      "planCategory": "Chat",
      "planType": "free",
      "name": "Free",
      "status": "active",
      "startDate": "1735678901",
      "endDate": "1767214901",
      "users": {
        "purchasedSeats": "1",
        "usedSeats": "1"
      }
    },
    {
      "planCategory": "CRM",
      "planType": "free",
      "name": "Free",
      "status": "active",
      "startDate": "1735678900",
      "endDate": "1767214900",
      "users": {
        "purchasedSeats": "1",
        "usedSeats": "1"
      }
    }
  ]
}

Retrieves details of your Brevo account. **Use this to:** - Get account information (email, name, company, address) - Check plan details (type, credits, expiration) - Get relay information (for transactional emails) - Check Marketing Automation status - Access organization and user identifiers **Key information returned:** - Complete account details (organization ID, user ID, company information) - Address and contact information - Plan configurations and credit allocations across different verticals - Marketing Automation settings and tracker key (when enabled) - SMTP relay configuration for transactional emails - Enterprise features availability status **Important considerations:** - Provides comprehensive account overview for billing and configuration management - Essential for understanding current plan limitations and feature availability - Marketing Automation key is only returned when Marketing Automation is enabled on the account - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available) - Relay configuration crucial for transactional email setup and deliverability - Enterprise status determines access to advanced features and sub-account management

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

{
  "organization_id": "5fa2b8c123456789abcdef01",
  "user_id": 1234567,
  "enterprise": false,
  "companyName": "Acme Marketing Corp",
  "email": "michael.davis@example.com",
  "firstName": "Michael",
  "lastName": "Davis",
  "plan": [
    {
      "credits": 250,
      "creditsType": "sendLimit",
      "type": "free"
    },
    {
      "credits": 15,
      "creditsType": "sendLimit",
      "type": "sms"
    }
  ],
  "relay": {
    "data": {
      "port": 587,
      "relay": "smtp-relay.brevo.com",
      "userName": "michael.davis@example.com"
    },
    "enabled": true
  },
  "address": {
    "city": "New York",
    "country": "United States",
    "street": "456 Business Ave",
    "zipCode": "10001"
  },
  "marketingAutomation": {
    "enabled": true,
    "key": "ma8k2x9v4h7p3d6f1c5e8b2a"
  },
  "planVerticals": [
    {
      "planCategory": "Marketing",
      "planType": "free",
      "name": "Free",
      "status": "active",
      "startDate": "1751234567",
      "endDate": "1753826567",
      "users": {
        "purchasedSeats": "1",
        "usedSeats": "1"
      },
      "credits": "250"
    },
    {
      "planCategory": "Chat",
      "planType": "free",
      "name": "Free",
      "status": "active",
      "startDate": "1735678901",
      "endDate": "1767214901",
      "users": {
        "purchasedSeats": "1",
        "usedSeats": "1"
      }
    },
    {
      "planCategory": "CRM",
      "planType": "free",
      "name": "Free",
      "status": "active",
      "startDate": "1735678900",
      "endDate": "1767214900",
      "users": {
        "purchasedSeats": "1",
        "usedSeats": "1"
      }
    }
  ]
}

Retrieves details of your Brevo account.

Use this to:

Get account information (email, name, company, address)
Check plan details (type, credits, expiration)
Get relay information (for transactional emails)
Check Marketing Automation status
Access organization and user identifiers

Key information returned:

Complete account details (organization ID, user ID, company information)
Address and contact information
Plan configurations and credit allocations across different verticals
Marketing Automation settings and tracker key (when enabled)
SMTP relay configuration for transactional emails
Enterprise features availability status

Important considerations:

Provides comprehensive account overview for billing and configuration management
Essential for understanding current plan limitations and feature availability
Marketing Automation key is only returned when Marketing Automation is enabled on the account
Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories (only returned when plan verticals are available)
Relay configuration crucial for transactional email setup and deliverability
Enterprise status determines access to advanced features and sub-account management

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Response

Account information retrieved successfully

organization_idstring

Unique identifier for the organization

user_idinteger

Unique identifier for the user

enterpriseboolean

Indicates if the account has enterprise features

companyNamestring

Name of the company

emailstringformat: "email"

firstNamestring

First Name

lastNamestring

Last Name

planlist of objects

Information about your plans and credits

relayobject

Information about your transactional email account

addressobject

Address informations

marketingAutomationobject

planVerticalslist of objects

Detailed information about different plan categories

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.account.getAccount();
8	}
9	main();

1	{
2	"organization_id": "5fa2b8c123456789abcdef01",
3	"user_id": 1234567,
4	"enterprise": false,
5	"companyName": "Acme Marketing Corp",
6	"email": "michael.davis@example.com",
7	"firstName": "Michael",
8	"lastName": "Davis",
9	"plan": [
10	{
11	"credits": 250,
12	"creditsType": "sendLimit",
13	"type": "free"
14	},
15	{
16	"credits": 15,
17	"creditsType": "sendLimit",
18	"type": "sms"
19	}
20	],
21	"relay": {
22	"data": {
23	"port": 587,
24	"relay": "smtp-relay.brevo.com",
25	"userName": "michael.davis@example.com"
26	},
27	"enabled": true
28	},
29	"address": {
30	"city": "New York",
31	"country": "United States",
32	"street": "456 Business Ave",
33	"zipCode": "10001"
34	},
35	"marketingAutomation": {
36	"enabled": true,
37	"key": "ma8k2x9v4h7p3d6f1c5e8b2a"
38	},
39	"planVerticals": [
40	{
41	"planCategory": "Marketing",
42	"planType": "free",
43	"name": "Free",
44	"status": "active",
45	"startDate": "1751234567",
46	"endDate": "1753826567",
47	"users": {
48	"purchasedSeats": "1",
49	"usedSeats": "1"
50	},
51	"credits": "250"
52	},
53	{
54	"planCategory": "Chat",
55	"planType": "free",
56	"name": "Free",
57	"status": "active",
58	"startDate": "1735678901",
59	"endDate": "1767214901",
60	"users": {
61	"purchasedSeats": "1",
62	"usedSeats": "1"
63	}
64	},
65	{
66	"planCategory": "CRM",
67	"planType": "free",
68	"name": "Free",
69	"status": "active",
70	"startDate": "1735678900",
71	"endDate": "1767214900",
72	"users": {
73	"purchasedSeats": "1",
74	"usedSeats": "1"
75	}
76	}
77	]
78	}