Activecampaign Python API Docs | dltHub

ActiveCampaign is a marketing automation and CRM platform that provides a REST API to manage contacts, lists, deals, automations, segments, tags, and related resources. The REST API base URL is https://{youraccount}.api-us1.com/api/3 and all requests require an Api-Token header containing your 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 Activecampaign data in under 10 minutes.

---

What data can I load from Activecampaign?

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

---

How do I authenticate with the Activecampaign API?

ActiveCampaign uses a personal API key. For the v3 REST API include the API key in the HTTP header 'Api-Token: YOUR_API_TOKEN'. Legacy v2 endpoints accept the api_key parameter.

1. Get your credentials

1. Log in to your ActiveCampaign account.
2. Navigate to Settings → Developer (or My Settings → Developer).
3. Copy the API URL (e.g., youraccount.api-us1.com).
4. Copy the API Access Token shown as Api-Token.
5. Use this token in the Api-Token header for all v3 API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.activecampaign_source]
api_token = "your_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:

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 Activecampaign 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 activecampaign_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline activecampaign_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 lists from the Activecampaign 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 activecampaign_source(api_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{youraccount}.api-us1.com/api/3",
            "auth": {
                "type": "api_key",
                "api_key": api_token,
            },
        },
        "resources": [
            {"name": "contacts", "endpoint": {"path": "contacts", "data_selector": "contacts"}},
            {"name": "lists", "endpoint": {"path": "lists", "data_selector": "lists"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM activecampaign_data.contacts LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("activecampaign_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 Activecampaign 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

If you receive 401 Unauthorized or 403 Forbidden, verify that the Api-Token header is present and contains a valid token. Older v2 endpoints used api_key as a query parameter, but v3 requires the header.

Rate limits

ActiveCampaign enforces rate limits. When a 429 Too Many Requests response is returned, back off and retry after the period indicated in the Retry-After header or after a short delay.

Pagination quirks

List endpoints return an object with a top‑level array (e.g., contacts) and a meta object that includes paging information (total, page_input). Use offset/limit parameters for simple pagination or id_greater for more efficient large‑dataset traversal. Older v2 endpoints used a page parameter and returned 20 records per page.

Common error responses

• 400 Bad Request – malformed parameters
• 401 Unauthorized – missing or invalid Api-Token
• 403 Forbidden – insufficient permissions
• 404 Not Found – invalid resource ID
• 429 Too Many Requests – rate limit exceeded

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