Skip to main content
GET
cURL

Path Parameters

ref
string
required

Booking reference (BK-YYYYMMDD-XXXX).

Example:

"BK-20260419-AB12"

Query Parameters

email
string<email>
required

Response

Booking.

id
integer
required
Example:

503

booking_reference
string
required
Example:

"BK-20260419-AB12"

customer_name
string
required
customer_email
string<email>
required
starts_at
string<date-time>
required
status
enum<string>
required
Available options:
pending,
confirmed,
cancelled,
completed,
no_show
service
object
customer_phone
string | null
ends_at
string<date-time> | null
payment_status
enum<string>
Available options:
not_required,
unpaid,
paid,
refunded
price_charged
integer | null
currency
string
customer_notes
string | null
admin_notes
string | null

Hidden in public lookups.

cancellation_reason
string | null
cancelled_at
string<date-time> | null
confirmed_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>