Salonist Python API Docs | dltHub

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

Last updated:

Salon Booking System is a REST API for the Salon Booking System WordPress plugin that exposes booking, availability, services, staff, and related resources for building custom apps and mobile clients. The REST API base URL is `` and Authentication is required via an API token supplied in request headers..

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


What data can I load from Salonist?

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

### Endpoints
Resource
----------
bookings
availability
services
staff
locations

How do I authenticate with the Salonist API?

Requests must include an Authorization header with a Bearer token, e.g., Authorization: Bearer <token>.

1. Get your credentials

  1. Log in to the Salon Booking System account dashboard.
  2. Navigate to the "API" or "Integrations" section.
  3. Click "Generate New API Token".
  4. Copy the generated token and store it securely.
  5. Use the token in the Authorization header for all API calls.

2. Add them to .dlt/secrets.toml

[sources.salonist_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:

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 Salonist 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 salonist_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline salonist_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 bookings and availability from the Salonist 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 salonist_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "", "auth": { "type": "bearer", "token": api_token, }, }, "resources": [ {"name": "bookings", "endpoint": {"path": "bookings", "data_selector": "bookings"}}, {"name": "availability", "endpoint": {"path": "availability", "data_selector": "slots"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="salonist_pipeline", destination="duckdb", dataset_name="salonist_data", ) load_info = pipeline.run(salonist_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("salonist_pipeline").dataset() sessions_df = data.bookings.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM salonist_data.bookings LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("salonist_pipeline").dataset() data.bookings.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 Salonist 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 Errors

  • 401 Unauthorized – The provided token is missing, malformed, or expired. Ensure the Authorization: Bearer <token> header is correctly set and the token is valid.
  • 403 Forbidden – The token is valid but lacks required scopes/permissions. Verify the API key or token has access to the requested resource.

Rate Limiting

  • 429 Too Many Requests – The client has exceeded the allowed request quota. Respect the Retry-After header if present and implement exponential backoff.

Pagination Issues

  • Some list endpoints paginate results using page and limit query parameters. Missing or incorrect pagination parameters can lead to incomplete data retrieval.

Server Errors

  • 5xx Responses – Temporary server problems. Retry after a short delay; if persistent, contact support.

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

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