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();

{
  "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
  },
  "organization_id": "5fa2b8c123456789abcdef01",
  "user_id": 1234567,
  "enterprise": false,
  "companyName": "Acme Marketing Corp",
  "email": "michael.davis@example.com",
  "firstName": "Michael",
  "lastName": "Davis",
  "address": {
    "city": "New York",
    "country": "United States",
    "street": "456 Business Ave",
    "zipCode": "10001"
  },
  "dateTimePreferences": {
    "timezone": "America/New_York",
    "timeFormat": "12",
    "dateFormat": "mm-dd-yyyy"
  },
  "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
View date/time preferences and account settings
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
SMTP relay configuration for transactional emails
Date/time preferences and account settings
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 required for advanced automation features
Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories
Relay configuration crucial for transactional email setup and deliverability
Date/time preferences affect campaign scheduling and reporting displays
Enterprise status determines access to advanced features and sub-account management

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 - View date/time preferences and account settings - 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 - SMTP relay configuration for transactional emails - Date/time preferences and account settings - 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 required for advanced automation features - Plan verticals show detailed breakdown across Marketing, Chat, and CRM categories - Relay configuration crucial for transactional email setup and deliverability - Date/time preferences affect campaign scheduling and reporting displays - 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

planlist of objects

Information about your plans and credits

relayobject

Information about your transactional email account

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

addressobject

Address informations

dateTimePreferencesobject

User's date and time preferences

marketingAutomationobject

planVerticalslist of objects

Detailed information about different plan categories