SystemeIO Python API Docs | dltHub

Build a SystemeIO-to-database pipeline in Python using dlt with automatic cursor support.

Last updated:

Systeme.io is a marketing platform that provides funnels, email marketing, products, and automation and exposes a RESTful public API to manage contacts, tags, subscriptions and other resources. The REST API base URL is https://api.systeme.io and All requests require an X-API-Key header containing a public API key.

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


What data can I load from SystemeIO?

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

ResourceEndpointMethodData selectorDescription
contacts/api/contactsGETList and retrieve contacts (supports filtering)
tags/api/tagsGETList tags and retrieve tag details
funnels/api/funnelsGETList funnels
products/api/productsGETList products
subscriptions/api/subscriptionsGETList subscriptions
campaigns/api/campaignsGETList campaigns
orders/api/ordersGETList orders
webhooks/api/webhooksGETList webhooks

How do I authenticate with the SystemeIO API?

Authenticate by creating a Public API Key in your Systeme.io account and include it in every request using the X-API-Key HTTP header (X-API-Key: your_api_key). Do not expose keys in client‑side code; use server‑side calls.

1. Get your credentials

  1. In your Systeme.io account click your profile picture → Settings.
  2. Scroll to 'Public API keys'.
  3. Click 'Create', give the key a name and optionally set an expiration.
  4. Save and immediately copy the token (it can only be copied once). If lost, delete and create a new key.

2. Add them to .dlt/secrets.toml

[sources.systeme_io_source] api_key = "your_systeme_io_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 SystemeIO 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 systeme_io_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline systeme_io_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 tags from the SystemeIO 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 systeme_io_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.systeme.io", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "contacts", "endpoint": {"path": "api/contacts"}}, {"name": "tags", "endpoint": {"path": "api/tags"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="systeme_io_pipeline", destination="duckdb", dataset_name="systeme_io_data", ) load_info = pipeline.run(systeme_io_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("systeme_io_pipeline").dataset() sessions_df = data.contacts.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM systeme_io_data.contacts LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("systeme_io_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 SystemeIO 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.


Troubleshooting

Authentication failures

If you receive 401 Unauthorized or 403 Forbidden responses ensure the X-API-Key header is present and correct. Public API keys are created in Settings → Public API keys and can only be copied once; if lost, create a new key.

Rate limits

The API enforces rate limits. Check the response headers X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Refill and the Retry-After header on 429 responses. Implement retry/backoff when you receive HTTP 429.

Pagination and response shapes

The documentation shows endpoints under /api/<resource> but does not include an explicit canonical JSON data key for lists. Perform a test GET against your account (e.g., GET /api/contacts) and inspect the JSON response to set the correct data_selector in the dlt schema.

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 SystemeIO?

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