Path parameters
string
required
Your booking token — either the booking slug from Online Booking → General or the lead token from Website Leads → Website Forms. See Authentication & tokens.
Response
Returns200 OK with the booking configuration.
string
Business display name.
string
URL of the business logo, if set.
string
Business phone.
string
Business email.
string
Business address.
string
Currency code (e.g.,
USD).string
The business’s timezone, used for availability.
number
Tax rate percentage applied to bookings.
string
Business type.
auto businesses include body_types.string
Optional welcome text for the page.
string
Brand color for the page.
boolean
Whether to show the company branding footer.
boolean
Whether to show the hero image.
number
Legacy compatibility value. Do not use it to calculate a selected booking’s length; availability uses the sum of the selected services’
estimated_duration values.number
How many days ahead customers can book (e.g.,
30).number
Minimum hours of notice before an appointment (e.g.,
24).string | null
Custom text to show after a successful booking, if configured.
boolean
true when a successful submission creates a Pending review order and reserves time; false when it creates a Pending review lead and releases the time for follow-up.object
CAPTCHA configuration for the resolved channel.
site_key is the public key assigned to the exact active hostname, and action is booking_submit.array
Any additional fees applied to bookings.
array
Bookable services, each with
id, name, base_price, estimated_duration (minutes), and applies_body_type_surcharge.Use applies_body_type_surcharge when you price the booking yourself: it says whether the body type’s surcharge_percent should be added on top of base_price for that service. It defaults to true.array | null
For
auto businesses: vehicle body types, each with id, name, and surcharge_percent. null for non-auto businesses.Example
Errors
Get availability
Next: fetch open time slots.
Hold a slot
Reserve a selected availability offer.