Path parameters
string
required
Your booking page token — either the booking slug (Settings → Booking Page) or the lead token (Settings → Website Leads). 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
Message shown after a successful booking.
string
Brand color for the page.
boolean
Whether to show the company branding footer.
boolean
Whether to show the hero image.
number
Default appointment length in minutes (e.g.,
60).number
How many days ahead customers can book (e.g.,
30).number
Minimum hours of notice before an appointment (e.g.,
24).array
Any additional fees applied to bookings.
array
Bookable services, each with
id, name, base_price, and estimated_duration (minutes).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.
Submit booking
Then: create the order or lead.