OnceHub Python API Docs | dltHub

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

Last updated:

OnceHub is a scheduling and appointment platform providing REST APIs to manage bookings, booking calendars, users, teams, contacts, webhooks and related scheduling resources. The REST API base URL is https://api.oncehub.com/v2 and All requests require an API key sent in the API-Key request header..

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


What data can I load from OnceHub?

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

ResourceEndpointMethodData selectorDescription
booking_calendars/booking-calendarsGETdataList booking calendars (availability containers)
booking_calendar/booking-calendars/{id}GETRetrieve a single booking calendar by id
booking_calendar_time_slots/booking-calendars/{id}/time-slotsGETdataRetrieve available time slots for a booking calendar
bookings/bookingsGETdataList bookings (appointments)
booking/bookings/{id}GETRetrieve a single booking
contacts/contactsGETdataList contacts
users/usersGETdataList users
teams/teamsGETdataList teams
webhooks/webhooksGETdataList webhook subscriptions
webhook_events/webhook-eventsGETdataList webhook event types
test_auth/testGETValidate API key (returns simple message)

How do I authenticate with the OnceHub API?

OnceHub uses an API key; include the key in the API-Key header (HTTPS only). Use the /test endpoint to validate the key.

1. Get your credentials

  1. Log in to your OnceHub account.
  2. Click the gear icon (top-right) and select Account Integrations.
  3. Open the APIs & Webhooks tile (APIs Integrations section).
  4. Copy the API key displayed at the top or click Regenerate to issue a new key.

2. Add them to .dlt/secrets.toml

[sources.once_hub_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 OnceHub 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 once_hub_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline once_hub_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 booking_calendars and bookings from the OnceHub 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 once_hub_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.oncehub.com/v2", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "booking_calendars", "endpoint": {"path": "booking-calendars", "data_selector": "data"}}, {"name": "bookings", "endpoint": {"path": "bookings", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="once_hub_pipeline", destination="duckdb", dataset_name="once_hub_data", ) load_info = pipeline.run(once_hub_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("once_hub_pipeline").dataset() sessions_df = data.booking_calendars.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM once_hub_data.booking_calendars LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("once_hub_pipeline").dataset() data.booking_calendars.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 OnceHub 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 requests return 401 or 403, confirm the API-Key header is present, the key is correct, and you are calling the v2 server over HTTPS. Use GET /test to validate the key.

Rate limits

The API may return 429 Too Many Requests when rate limits are exceeded. Implement exponential backoff and retries. Monitor response headers for rate-limit hints.

Pagination and list envelopes

List endpoints return a consistent ListResponseBase envelope. Records are provided under the "data" key. When paginated, follow the pagination fields supplied in the envelope (check response for paging metadata) and request subsequent pages using the documented query parameters.

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

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