Bookline API
Read and manage your Bookline account's data from your own systems with the Bookline API.
The Bookline API lets you read and manage your Bookline account’s data from your own systems: your CRM, your BI tools, your automations or an AI agent. It is the same information you see in the portal (venues, agents, activity, metrics…), with the same numbers as the dashboard.
It is an HTTPS + JSON API. What each key can do, read only or also write, and in which areas, is set by the scopes you choose when you create it.
API address
Section titled “API address”| Base URL | Interactive reference |
|---|---|
https://api.bookline.ai/v1 |
api.bookline.ai/v1/docs |
The interactive reference lists every endpoint with a description of each field. The OpenAPI schema is at https://api.bookline.ai/v1/openapi.json, in case you want to generate a client.
What is available today
Section titled “What is available today”- Metrics: the headline figures, the conversion funnel, the calls breakdown, reservations and survey ratings.
- Venues: your venues and their details; change their name, website and contact details.
- Calls: the calls your agents answer, with their transcript.
- Chats: the WhatsApp conversations your agents hold, with their messages.
- Bookings: your bookings by reservation date.
- Contacts: the people who reached you; add and change them.
- Agents: your agents, with their type, language and venue; rename them.
- Knowledge bases: what your agents answer from; create, change and delete text ones.
- Campaigns: your notification campaigns and their runs; pause them.
- Phone numbers and integrations: the lines your agents answer and the systems you connected.
- Team members: who has access to your portal; change or remove their access.
- Billing: your billing accounts, invoices and contracted services.
Every route and the scope it needs is in Endpoints; each domain has its own page in this section. Changes follow the rules in Writing data.
Quick start
Section titled “Quick start”1. Create a key. In the portal, under Administration in the menu, open API keys, click Create key and copy it: it is shown only once. The steps and the scopes are in Keys and scopes.
2. List the venues your key reads. Keep the key in an environment variable so it never lands in your shell history or scripts. It is not echoed as you type it:
read -rs "BOOKLINE_API_KEY?API key: " # zsh; in bash: read -rsp "API key: " BOOKLINE_API_KEYexport BOOKLINE_API_KEYBASE=https://api.bookline.ai/v1
curl -s -H "apikey: $BOOKLINE_API_KEY" "$BASE/venues"3. Get your first metrics. October’s summary, day by day, in Madrid time:
curl -s -H "apikey: $BOOKLINE_API_KEY" \ "$BASE/metrics/summary?from=2026-10-01&to=2026-10-31&granularity=day&timezone=Europe/Madrid"If your key reads several customers, add &customer_id=<customer uuid> to every call. When you’re done, unset BOOKLINE_API_KEY.
Related
Section titled “Related”- Keys and scopes: creating and revoking keys, scopes and what each key reads.
- Endpoints: every route, and the metrics’ parameters and data rules.
- Writing data: versions, retries and the write limit.
- Errors and rate limits: error codes, limits and headers.
- Connect Claude or ChatGPT: use your data from an AI app.
