Mixmax Python API Docs | dltHub
Build a Mixmax-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Mixmax is a sales‑engagement and email productivity platform that provides a REST API to access and manipulate Mixmax account data. The REST API base URL is https://api.mixmax.com/v1 and All requests require an API token provided via the X-API-Token header or the apiToken query parameter..
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 Mixmax data in under 10 minutes.
What data can I load from Mixmax?
Here are some of the endpoints you can load from Mixmax:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| users | /users/me | GET | Retrieve current authenticated user (single object) | |
| messages | /messages | GET | results | List messages for the account (collection) |
| sequences | /sequences | GET | results | List sequences (collection) |
| snippets | /snippets | GET | results | List templates/snippets (collection) |
| polls | /polls | GET | results | List polls (collection) |
| livefeed_events | /livefeed/events | GET | results | List livefeed events (collection) |
| appointment_links | /appointmentlinks | GET | results | List appointment links (collection) |
| salesforce_lead | /salesforce/lead/:id | GET | Retrieve a Salesforce lead synced via Mixmax (single object) | |
| sequences_recipients | /sequences/:id/recipients | GET | results | List recipients for a sequence (collection) |
| reports_table | /reports/data/table | POST | results | Retrieve report table data (collection) |
How do I authenticate with the Mixmax API?
Create a developer API token in Mixmax Settings ▶ Integrations and send it on every request either as the X-API-Token header or as the apiToken query parameter.
1. Get your credentials
- Sign in to your Mixmax account.
- Open Settings ▶ Integrations (or Dashboard Settings ▶ Integrations).
- Click to create/generate a developer API token.
- Copy and securely store the token (shown only once).
- Use it in the X-API-Token header or apiToken query parameter for API calls.
2. Add them to .dlt/secrets.toml
[sources.mixmax_source] api_token = "your_mixmax_api_token_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 Mixmax 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 mixmax_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline mixmax_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset mixmax_data The duckdb destination used duckdb:/mixmax.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline mixmax_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 users and messages from the Mixmax 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 mixmax_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.mixmax.com/v1", "auth": { "type": "api_key", "api_token": api_token, }, }, "resources": [ {"name": "users", "endpoint": {"path": "users/me"}}, {"name": "messages", "endpoint": {"path": "messages", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="mixmax_pipeline", destination="duckdb", dataset_name="mixmax_data", ) load_info = pipeline.run(mixmax_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("mixmax_pipeline").dataset() sessions_df = data.messages.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM mixmax_data.messages LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("mixmax_pipeline").dataset() data.messages.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 Mixmax data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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.
Troubleshooting
Authentication failures
If you receive 401/403, confirm the API token is correct, not expired, and is sent either in X-API-Token header or as apiToken query parameter. Tokens are shown only once when created in Settings; regenerate if lost.
Rate limiting
Mixmax enforces 120 requests per 60 seconds per IP/user. Exceeding the limit returns HTTP 429 with a Retry-After header. Monitor X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers.
Pagination
Collection responses return a wrapper with keys: results (array), next (cursor), previous (cursor), hasNext, hasPrevious. Use ?limit and ?next or ?previous query params to page. Collections are returned newest-first.
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.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Mixmax?
Request dlt skills, commands, AGENT.md files, and AI-native context.