Developer docs menu
Getting started
Concepts
The words the API uses, and how it treats money and time.
The things you work with
| Word | What it is |
|---|---|
| Business | One company that takes bookings. It is named by its slug, the last part of its booking page address. |
| Service | Something the business sells, with a length and a base price. |
| Requirements | What a service needs to know before it can be priced or booked: the questions that set the price, other questions, add-ons, and whether an address is needed. |
| Quote | The real price for a job, worked out by the business’s own pricing rules from the customer’s answers. |
| Slot | A free time. Each has a signed id, good for 24 hours. |
| Hold | A slot kept for you for a few minutes while the customer decides. |
| Booking | A request to book for a named customer, and then the booking itself. |
Answers
A success is { "data": … }. A refusal is { "error", "code", "details", "requestId" }. error is a sentence you can act on or repeat to your user. code is what software should test. details is there when something helps put the request right. Quote requestId if you report a problem.
Money
Money is a number in the major unit of currency: 95 is £95.00 when the currency is GBP. The currency is the business’s own. Nothing is ever converted.
Time
An instant is an ISO 8601 string in UTC, such as
2026-12-01T09:00:00.000Z.timezoneis the business’s own IANA zone. It is the only clock to tell its customers times in.A day is
YYYY-MM-DDand a clock time isHH:MM, both as the business counts them.
Who you are
Send X-Agent with your agent’s name, such as Acme Receptionist. X-Agent-Client can name what runs it. Both are kept on what you book.
What a business can switch off
A business can stop AI assistants booking it. The refusal is agents_off_for_business, and details.bookingUrl is the page to send the customer to instead. A business can also choose to show a price range or a starting price in place of the exact figure.
Still have questions? Contact support