Klaviyo Python API Docs | dltHub

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

Last updated:

Klaviyo's REST API uses private and public keys for authentication; it supports various HTTP methods for data management and retrieval. The latest API documentation is available on the Klaviyo Developers site. For initial setup, Postman collections are recommended. The REST API base URL is https://a.klaviyo.com/api and All requests require a private API key passed in the Authorization header as 'Klaviyo-API-Key <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 Klaviyo data in under 10 minutes.


What data can I load from Klaviyo?

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

ResourceEndpointMethodData selectorDescription
lists/listsGETdataRetrieve all email/SMS lists
profiles/profilesGETdataRetrieve profile (customer) information
metrics/metricsGETdataList all tracked metrics
campaigns/campaignsGETdataGet details of email campaigns
events/eventsGETdataFetch recorded event data
segments/segmentsGETdataList audience segments
templates/templatesGETdataRetrieve email template metadata
tags/tagsGETdataList tags applied to objects
coupons/couponsGETdataGet discount coupon information
flows/flowsGETdataList automated flows

How do I authenticate with the Klaviyo API?

Authentication is performed by adding an 'Authorization' header set to 'Klaviyo-API-Key <your_private_api_key>'.

1. Get your credentials

  1. Log in to your Klaviyo account.
  2. Click on your account name in the lower‑left corner and select "Account".
  3. In the Account Settings menu, choose "Settings" → "API Keys".
  4. Click "Create API Key", give it a descriptive name, and copy the generated private key.
  5. Store the key securely; it will be used as the value for the api_key parameter.

2. Add them to .dlt/secrets.toml

[sources.klaviyo_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 Klaviyo 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 klaviyo_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline klaviyo_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 profiles and lists from the Klaviyo 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 klaviyo_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://a.klaviyo.com/api", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "profiles", "endpoint": {"path": "profiles", "data_selector": "data"}}, {"name": "lists", "endpoint": {"path": "lists", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="klaviyo_pipeline", destination="duckdb", dataset_name="klaviyo_data", ) load_info = pipeline.run(klaviyo_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("klaviyo_pipeline").dataset() sessions_df = data.profiles.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM klaviyo_data.profiles LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("klaviyo_pipeline").dataset() data.profiles.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 Klaviyo 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 Klaviyo?

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