Mailmodo Python API Docs | dltHub

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

Last updated:

The Mailmodo API endpoint is https://api.mailmodo.com/ for making API calls. Use this base URL for all Mailmodo API requests. Mailmodo's API allows setting up transactional email campaigns without coding the emails directly. The REST API base URL is https://api.mailmodo.com/ and All requests require an API key sent in the mmApiKey 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 Mailmodo data in under 10 minutes.


What data can I load from Mailmodo?

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

ResourceEndpointMethodData selectorDescription
campaign_reports/api/v1/campaignReports/GETdataReturns a list of campaign report objects.
trigger_campaign/api/v1/triggerCampaign/<campaign_id>POSTTriggers a specific campaign.
contacts/api/v1/contacts/GETRetrieves contact records. (uncertain)
templates/api/v1/templates/GETRetrieves email templates. (uncertain)
lists/api/v1/lists/GETRetrieves audience lists. (uncertain)

How do I authenticate with the Mailmodo API?

Include the API key in the request header mmApiKey: <your_api_key> for every endpoint.

1. Get your credentials

  1. Log in to your Mailmodo account.
  2. Go to SettingsAPI Keys.
  3. Click Show API Key to view the existing key, or click Add API Key to create a new one.
  4. Copy the displayed key for use in your integration.

2. Add them to .dlt/secrets.toml

[sources.mailmodo_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:

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 Mailmodo 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 mailmodo_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline mailmodo_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 campaign_reports and trigger_campaign from the Mailmodo 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 mailmodo_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.mailmodo.com/", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "campaign_reports", "endpoint": {"path": "api/v1/campaignReports/", "data_selector": "data"}}, {"name": "trigger_campaign", "endpoint": {"path": "api/v1/triggerCampaign/<campaign_id>"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="mailmodo_pipeline", destination="duckdb", dataset_name="mailmodo_data", ) load_info = pipeline.run(mailmodo_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("mailmodo_pipeline").dataset() sessions_df = data.campaign_reports.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM mailmodo_data.campaign_reports LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("mailmodo_pipeline").dataset() data.campaign_reports.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 Mailmodo 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 Mailmodo?

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