Skip to content

Bookings

Create, fetch, update, and delete bookings; list bookings by staff or customer.

Booking

A booking, as returned in API responses.

idstring
Example:"bk_123456"
typestring

What kind of booking this is:

Enum:"SESSION""APPOINTMENT""EVENT"
Example:"APPOINTMENT"
calendar_idstring
Example:"cal_123456"
account_idstring
Example:"acc_123456"
provider_idstring

Id of the staff member assigned to this booking.

Example:"provider_123456"
consumer_idsArray of strings, <= 50 items

Ids of the customers attending this booking.

Example:
[ "cust_123456" ]
service_idstring

Id of the service booked. Empty for an EVENT.

Example:"svc_123456"
start_atstring, (date-time)

Start of the booking, an RFC 3339 date-time in UTC (Z). A time sent with an offset is returned as the same moment in UTC: 2026-11-19T08:30:00+08:00 is returned as 2026-11-19T00:30:00Z.

Example:"2026-01-20T09:00:00Z"
end_atstring, (date-time)

End of the booking, an RFC 3339 date-time in UTC (Z), as the same moment as it was sent.

Example:"2026-01-20T10:00:00Z"
booking_idstring

External booking reference id.

Example:"ext_bk_654321"
costnumber, (double), >= 0

Empty for an EVENT.

Example:50
titlestring, <= 255 characters
Example:"Consultation"
notesstring, <= 1500 characters
Example:"Customer requested a reminder call the day before."
statusstring
Enum:"CANCELLED""CONFIRMED"
Example:"CONFIRMED"
labelstring, <= 100 characters

Free-text label for the booking, e.g. a status or reminder tag such as RUNNING_LATE or NO_SHOW. Empty for an EVENT.

Example:"RUNNING_LATE"
locationobject(BookingLocation)

Meeting location of a booking.

created_atstring, (date-time)

When the booking was created, an RFC 3339 date-time in UTC (Z).

Example:"2026-01-15T12:00:00Z"
sourcestring, <= 100 characters
Example:"booking_page"
meta_dataobject, <= 5 properties

Unstructured key/value passthrough data, with up to 5 entries and each value up to 1500 characters.

Example:
{ "referred_by": "google_ads" }
{ "id": "bk_123456", "type": "APPOINTMENT", "calendar_id": "cal_123456", "account_id": "acc_123456", "provider_id": "provider_123456", "consumer_ids": [ "cust_123456" ], "service_id": "svc_123456", "start_at": "2026-01-20T09:00:00Z", "end_at": "2026-01-20T10:00:00Z", "booking_id": "ext_bk_654321", "cost": 50, "title": "Consultation", "notes": "Customer requested a reminder call the day before.", "status": "CONFIRMED", "label": "RUNNING_LATE", "location": { "type": [ … ], "video_type": [ … ] }, "created_at": "2026-01-15T12:00:00Z", "source": "booking_page", "meta_data": { "referred_by": "google_ads" } }