No logo available for Iterable to DuckDB connector icon

Load Iterable data to DuckDB

Build a Iterable to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Iterable API base URL, auth, endpoints, and incremental loading.

SourceIterableDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

Iterable is a marketing automation platform that provides a REST API for interacting with user profiles, campaigns, journeys, and project data. Everything needed to build a working Iterable → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your Iterable to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from Iterable to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Iterable API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


Iterable API at a glance

Base URLhttps://api.iterable.com
Example endpointGET api/lists
Records found atlists
Authenticationall requests require an Api-Key header, and some require a Bearer token in the Authorization header for user-specific data — sent in the Authorization header, prefixed Bearer
Also requiredApi-Key
PaginationPage-number
API referencehttps://api.iterable.com/api/docs

These values come from the Iterable API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the Iterable API?

API requests require an 'Api-Key' header containing your API key. For endpoints requiring user-specific data access, an additional 'Authorization' header using the Bearer schema with a valid JSON Web Token (JWT) is required.

1. Get your credentials

Log in to your Iterable account, navigate to the Integrations menu, select API Keys, click New API Key, provide a name and select the appropriate type, then save the key securely as it will not be displayed again.

2. Add them to .dlt/secrets.toml

[sources.iterable_source] iterable_api_key = "your_api_key_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What Iterable data can I load into DuckDB?

These are the Iterable endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
lists/api/listsGETlistsRetrieves all subscriber lists.
catalogs/api/catalogsGETRetrieves all catalogs.
catalog_items/api/catalogs/{catalogName}/itemsGETcatalogItemsWithPropertiesLists items in a specific catalog.
user_events/api/events/{email}GETeventsRetrieves events tracked for a user by email.
campaigns/api/campaignsGETRetrieves a list of campaigns.

How do I load only new Iterable records?

The Iterable API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "lists", "endpoint": { "path": "api/lists", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated Iterable pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /api/users/update and /api/campaigns from the Iterable API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def iterable_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.iterable.com", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "lists", "endpoint": {"path": "api/lists", "data_selector": "lists"}}, {"name": "catalog_items", "endpoint": {"path": "api/catalogs/{catalogName}/items", "data_selector": "catalogItemsWithProperties"}} ], } yield from rest_api_resources(config) def load_iterable_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="iterable_pipeline", destination="duckdb", dataset_name="iterable_data", ) load_info = pipeline.run(iterable_source()) print(load_info) if __name__ == "__main__": load_iterable_to_duckdb()

Run it with python iterable_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query Iterable data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

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

SQL:

SELECT * FROM iterable_data.lists LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the Iterable to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw Iterable loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load Iterable data to?

dlt loads into any of these — only the destination argument changes:

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

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for Iterable to DuckDB?

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