Getting Started

Integrate Bookr bookings into your website in three steps.

Step 1: Get Your API Key

Ask the workspace admin to create a Partner for your organisation in the Bookr dashboard under Partners → New Partner.
On the partner detail page, click “Generate New Key”.
Copy the API key immediately — it is shown only once and cannot be retrieved later.

Step 2: Embed the Booking Widget

Copy the iframe code from the partner detail page (under “Embed Tokens”) and paste it into your website HTML:

<iframe
  src="https://bookr.studio/embed/your-workspace?token=YOUR_EMBED_TOKEN"
  width="100%"
  height="600"
  frameborder="0"
></iframe>

The embed token is a separate, powerless credential — it can only display and book the catalogs you pick for it, never call the /v1 API. It is created and revoked on the partner page, not the API key from Step 1. See Embedding with Tokens for the full walkthrough.

URL Parameters

Parameter	Required	Description
`token`	Yes	Your embed token. Scopes the catalog to the catalogs picked for that token (empty selection = all of the partner's catalogs).
`item`	No	Pre-select a specific bookable item by ID.
`category`	No	Filter items to a specific category ID.
`ref`	No	Your internal reference. Stored with the booking for tracking.
`callback`	No	URL to redirect the user to after booking. The booking number is appended as `?bookingNumber=...`
`name`	No	Pre-fill the booker's name.
`email`	No	Pre-fill the booker's email.
`phone`	No	Pre-fill the booker's phone number.

Step 3: Handle the Callback

After a successful booking, the user is redirected to your callback URL with the booking number appended:

https://yoursite.com/booking-complete?bookingNumber=HTL-20260401-A1B2

Use the public API to fetch booking details:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://bookr.studio/api/v1/bookings/HTL-20260401-A1B2

Authentication

All API requests use Bearer token authentication. Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://bookr.studio/api/v1/catalog

The API key scopes requests to items assigned to your partner catalog. See the full API reference for all available endpoints.

API Reference →