Brevo Python API Docs | dltHub

Brevo is a cloud-based marketing and transactional messaging platform providing REST APIs for contacts, campaigns, transactional messaging, SMS, WhatsApp, tracker/events, and CRM features. The REST API base URL is https://api.brevo.com/v3 and All requests require an API key (or OAuth2) for authentication..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Brevo data in under 10 minutes.

---

What data can I load from Brevo?

Here are some of the endpoints you can load from Brevo:

---

How do I authenticate with the Brevo API?

Brevo supports API key authentication (v3 API keys) sent in the API key header (api-key) or via OAuth 2.0. For API key usage include header: api-key: <your_api_key> (and some SDKs also accept Authorization: Bearer when using OAuth).

1. Get your credentials

1. Log into your Brevo account at https://app.brevo.com. 2) Navigate to Settings -> SMTP & API -> API Keys (or “Create and manage your API keys” page). 3) Create a new v3 API key (name it) and copy the key. 4) Optionally restrict by IP or scope in the dashboard.

2. Add them to .dlt/secrets.toml

Copy
[sources.brevo_source]
api_key = "your_api_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Brevo API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python brevo_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline brevo_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset brevo_data
The duckdb destination used duckdb:/brevo.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline brevo_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads contacts and lists from the Brevo API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def brevo_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.brevo.com/v3",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "contacts", "endpoint": {"path": "contacts", "data_selector": "contacts"}},
            {"name": "lists", "endpoint": {"path": "contacts/lists", "data_selector": "lists"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="brevo_pipeline",
        destination="duckdb",
        dataset_name="brevo_data",
    )
    load_info = pipeline.run(brevo_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("brevo_pipeline").dataset()
sessions_df = data.contacts.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM brevo_data.contacts LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("brevo_pipeline").dataset()
data.contacts.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Brevo data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If you receive 401 Unauthorized or 403 Forbidden: verify you are using a valid v3 API key from the Brevo dashboard. Ensure the header is set to api-key: <your_api_key> and the key has not been revoked or IP-restricted.

Rate limits

Brevo enforces rate limits. When you hit limits the API returns 429 Too Many Requests and includes rate-limit headers; implement exponential backoff and read the Limit headers to determine reset timings.

Pagination

Many list endpoints are paginated. Responses include arrays under keys such as contacts, lists, templates, etc., plus pagination fields (limit, offset, count or total) — iterate using offset/limit parameters or provided next page links.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack