Mail Blaze Python API Docs | dltHub

Build a Mail Blaze-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Mail Blaze's REST API allows developers to manage email lists, subscribers, templates, and campaigns. The API documentation provides detailed instructions for integration. Essential endpoints include /lists/{list_uid}/subscribers and /lists/{list_uid}/subscribers/search-by-email. The REST API base URL is https://control.mailblaze.com/api and All requests require your Public Key sent in the Authorization header (token passed as header).

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 Mail Blaze data in under 10 minutes.


What data can I load from Mail Blaze?

Here are some of the endpoints you can load from Mail Blaze:

ResourceEndpointMethodData selectorDescription
lists/listsGETlistsGet all lists (paginated)
list/lists/{list_uid}GETGet a specific list by UID
list_segments/lists/{list_uid}/segmentsGETsegmentsGet segments for a list
list_fields/lists/{list_uid}/fieldsGETfieldsGet fields for a list
subscribers/lists/{list_uid}/subscribersGETsubscribersGet subscribers for a list (paginated)
subscribers_search_by_email/lists/{list_uid}/subscribers/search-by-emailGETSearch subscriber by email (single object or 404)
templates/templatesGETtemplatesGet all templates (paginated)
template/template/{template_uid}GETGet a specific template
campaigns/campaignsGETcampaignsGet campaigns (paginated)
transactional/transactionalGETtransactionalGet transactional emails (paginated)
transactional_single/transactional/{email_uid}GETGet single transactional email details

How do I authenticate with the Mail Blaze API?

Include the account Public Key in the Authorization header of every request, and set Content-Type appropriately (examples use application/x-www-form-urlencoded for form endpoints and application/json for JSON endpoints).

1. Get your credentials

  1. Log in to your Mail Blaze account at https://control.mailblaze.com. 2) Open account/dashboard or API settings (API Documentation / API Essentials sections). 3) Locate or generate your Public Key (API token) used for API access. 4) Copy the Public Key and use it in the Authorization header for requests.

2. Add them to .dlt/secrets.toml

[sources.mail_blaze_source] authorization = "YOUR_PUBLIC_KEY"

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:

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

1. Install the dlt AI Workbench:

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:

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 Mail Blaze 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:

python mail_blaze_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline mail_blaze_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 lists and subscribers from the Mail Blaze API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def mail_blaze_source(authorization=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://control.mailblaze.com/api", "auth": { "type": "api_key", "authorization": authorization, }, }, "resources": [ {"name": "lists", "endpoint": {"path": "lists", "data_selector": "lists"}}, {"name": "subscribers", "endpoint": {"path": "lists/{list_uid}/subscribers", "data_selector": "subscribers"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="mail_blaze_pipeline", destination="duckdb", dataset_name="mail_blaze_data", ) load_info = pipeline.run(mail_blaze_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):

import dlt data = dlt.pipeline("mail_blaze_pipeline").dataset() sessions_df = data.lists.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM mail_blaze_data.lists LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("mail_blaze_pipeline").dataset() data.lists.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 Mail Blaze data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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


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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Mail Blaze?

Request dlt skills, commands, AGENT.md files, and AI-native context.