For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Getting started
    • Overview
    • Quickstart
      • Key concepts
      • Postman workspace
    • Authentication
    • Rate limits
  • Messaging API
    • Send transactional email
    • Send transactional SMS
    • Send transactional WhatsApp
  • Marketing Platform
    • Manage your contacts
    • Track website activity
    • Send WhatsApp campaigns
    • Weekly event exports
  • Webhooks
    • Getting started
    • Conversations webhooks
    • Payment webhooks
    • Marketing webhooks
    • Transactional webhooks
    • Loyalty webhooks
    • Batched webhooks
    • Secure webhook calls
    • Meetings and phone webhooks
    • Push notification webhooks
    • Sales CRM webhooks
  • Conversations
    • Getting started
    • Customize the chat widget
    • JavaScript API reference
    • REST API reference
    • Conversations webhooks
  • eCommerce
    • Activate eCommerce app
    • Manage product categories
    • Manage products
    • Manage orders
    • Coupon collections
    • eCommerce tracker events
  • Loyalty
    • Overview
    • Set up a program
    • Enroll members
    • Credit & debit points
    • Read member data
    • Best practices
  • Custom Objects
    • Custom objects management
  • Brevo tracker and events
    • Getting started
    • JavaScript implementation
    • REST implementation
    • Legacy tracker documentation
    • Events
  • Accounts and settings
    • Senders and domains
    • User activity logs
    • External feeds
    • Invited users
LogoLogo
Help CenterAPI KeysStatusSign In
On this page
  • Overview
  • Get started
  • Fork the workspace
  • Configure your environment
  • Test your first request
  • Best practices
Getting startedQuickstart

Postman workspace

Test and explore the Brevo API using our Postman collection
Was this page helpful?
Previous

Authentication schemes

Choose between API key and OAuth 2.0 authentication for the Brevo API
Next
Built with

Overview

Use our Postman workspace to test API endpoints, explore collections, and integrate with your development workflow. The workspace includes pre-configured environments and every available endpoint.

Run in Postman

Get started

Fork the workspace

Click the button above to open the Postman workspace. Fork it to your team space to make it visible to your organization members.

Exploring the collections

Browse available endpoints in the left panel and view documentation in the middle panel.

Configure your environment

The workspace includes a default environment with pre-configured variables. Set the {{api-key}} variable before making requests.

1

Get your API key

Retrieve your API key from your Brevo account settings. See the API key authentication guide for instructions.

2

Set the environment variable

Add your API key to the {{api-key}} variable in your Postman environment.

Setting up your environment

Import the default environment directly via this link.

Test your first request

Once your environment is configured, all endpoints inherit the {{api-key}} variable. Test your setup by fetching your account details:

1

Select the endpoint

Choose GET /account from the endpoint list.

2

Send the request

Click Send to execute the request.

3

Review the response

The response displays your account information as JSON, confirming your API key is valid.

Fetching data

Best practices

  • Keep collections updated: Sync your forked collection regularly to receive the latest endpoint updates.
  • Contribute improvements: Submit pull requests for collection enhancements. We review and merge contributions.
  • Use environment variables: Store sensitive values like API keys in environment variables, not in requests.