Getting startedAuthentication

API key authentication

Generate and use an API key to authenticate your Brevo API requests

API keys authenticate your requests to the Brevo API. Generate an API key from your account settings and include it in the api-key header for each request.

Requirements

You need a Brevo account. Sign up if you don’t have one yet.

Generate an API key

1

Access account settings

Log in to your Brevo account and access the STMP & API settings page.

2

Generate new API key

Under the API keys tab, click Generate a new API key.

SMTP & API settings

3

Name your API key

Enter a descriptive name for your API key (e.g., “Production API”, “Development API”).

Name API key

4

Generate the key

Click Generate. The API key is displayed once.

API key generated

5

Copy and save your API key

Copy the API key immediately and store it securely. You won’t be able to view it again after closing the dialog.

Store your API key securely. If you lose it, you’ll need to generate a new one. Treat API keys like passwords—never commit them to version control or share them publicly.

6

Whitelist your IP address (optional)

To use your API key in the developer portal playground, whitelist your current IP address. See IP security for instructions.

Whitelist your IP address

Use your API key

Include your API key in the api-key header for all API requests. This endpoint validates your API key and returns your account details

Your API key identifies your account and authorizes API access. Include it in every request to authenticate your calls.

GET
/v3/account
1import { BrevoApiClient } from "brevo";
2
3const client = new BrevoApiClient({ apiKey: "YOUR_API_KEY", partnerKey: "YOUR_PARTNER_KEY" });
4await client.get.account();
GET
https://api.brevo.com/v3/account
Try your API key