Cronofy Python API Docs | dltHub

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

Last updated:

Cronofy's API allows calendar synchronization and scheduling. It provides stable, fully operational features with no breaking changes. The API supports creating, querying, and canceling scheduling requests. The REST API base URL is https://{data_center_url}/v1 and All requests require a Bearer token (access token or 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 Cronofy data in under 10 minutes.


What data can I load from Cronofy?

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

ResourceEndpointMethodData selectorDescription
calendarsv1/calendarsGETcalendarsList authenticated user's calendars.
eventsv1/eventsGETeventsRead events within a date range; supports pagination.
available_periodsv1/available_periodsGETavailable_periodsRetrieve available periods for an account.
notification_channelsv1/notification_channelsGETchannelsList push notification channels.
oauth_tokenoauth/tokenPOSTExchange authorization code for access and refresh tokens.

How do I authenticate with the Cronofy API?

Cronofy uses OAuth 2.0 Bearer tokens for user‑scoped calls and the client_secret as a Bearer token for application‑level calls. Include the token in the Authorization header.

1. Get your credentials

  1. Log in to the Cronofy Developer Dashboard and create a new application. 2) Record the client_id and client_secret displayed. 3) Implement the OAuth Authorization Code flow to receive an authorization code from a user. 4) Exchange the code at the token endpoint {data_center_url}/oauth/token for an access_token and refresh_token.

2. Add them to .dlt/secrets.toml

[sources.cronofy_source] access_token = "your_user_access_token_here" # or for application auth (internal app) pass client_secret as API key client_secret = "your_client_secret_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 Cronofy 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 cronofy_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline cronofy_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 calendars and events from the Cronofy 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 cronofy_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{data_center_url}/v1", "auth": { "type": "bearer", "access_token": access_token, }, }, "resources": [ {"name": "calendars", "endpoint": {"path": "v1/calendars", "data_selector": "calendars"}}, {"name": "events", "endpoint": {"path": "v1/events", "data_selector": "events"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="cronofy_pipeline", destination="duckdb", dataset_name="cronofy_data", ) load_info = pipeline.run(cronofy_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("cronofy_pipeline").dataset() sessions_df = data.events.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM cronofy_data.events LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("cronofy_pipeline").dataset() data.events.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 Cronofy 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 Cronofy?

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