Omnisend Python API Docs | dltHub

Omnisend is a marketing automation platform and REST API for managing contacts, products, orders, events and automations for ecommerce stores. The REST API base URL is https://api.omnisend.com/v5 and all requests require an X-API-KEY header (API key) 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 Omnisend data in under 10 minutes.

---

What data can I load from Omnisend?

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

---

How do I authenticate with the Omnisend API?

Omnisend uses API keys passed in the X-API-KEY HTTP header. Some endpoints also support OAuth/Bearer for apps; for server-to-server REST integrations create a brand API key in the Omnisend dashboard and include it as X-API-KEY in every request.

1. Get your credentials

1. Log into Omnisend dashboard. 2) Go to Store Settings → API Keys (or follow Generate an API Key). 3) Click Create API key, select scopes (Contacts, Orders, Products, Events, etc.), create and copy the key. 4) Use the created key in X-API-KEY header for requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.omnisend_source]
api_key = "YOUR_OMNISEND_API_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:

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 Omnisend 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 omnisend_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline omnisend_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 products from the Omnisend 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 omnisend_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.omnisend.com/v5",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "contacts", "endpoint": {"path": "contacts", "data_selector": "contacts"}},
            {"name": "products", "endpoint": {"path": "products", "data_selector": "products"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="omnisend_pipeline",
        destination="duckdb",
        dataset_name="omnisend_data",
    )
    load_info = pipeline.run(omnisend_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("omnisend_pipeline").dataset()
sessions_df = data.contacts.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM omnisend_data.contacts LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("omnisend_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 Omnisend 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

401/403 errors indicate missing or invalid API key. Verify you are sending the API key in the X-API-KEY header and that the key has the required scopes for the endpoint. Use API Logs (Store Settings → API Logs) to inspect requests.

Rate limits

The API enforces rate limiting; when you receive 429 responses back off and retry with exponential backoff. Keep batch sizes small (batch payloads recommended <=1MB) to reduce calls.

Pagination and large result sets

List endpoints use standard pagination parameters (limit/offset or cursor-style pagination per endpoint). Use the response pagination fields (returned in the endpoint response) to page through results. For large syncs prefer batch endpoints where available.

Validation & request errors

400 responses indicate invalid payloads or missing required fields. Examine response error body for field-level messages. 500-series errors indicate server-side issues; retry with backoff and contact Omnisend support if persistent.

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