Bookings
The booking flow: what can be booked, free slots, and the bookings themselves.
The booking object
As returned by GET /bookings, one element of the list. Every endpoint below that returns this resource returns exactly these fields.
| Name | Type | Description |
|---|---|---|
idrequired | string (uuid) | UUID |
contact_idrequired | string (uuid) | null | The contact this booking is for |
assignee_user_idrequired | string (uuid) | null | The member who owns the slot |
typerequired | object | null | The booking type, when one is set |
type.idrequired | string (uuid) | UUID |
type.namerequired | string | |
titlerequired | string | null | Snapshotted from the type name at booking time |
locationrequired | string | null | Snapshotted from the type at booking time |
notesrequired | string | null | Free text recorded with the booking |
starts_atrequired | string (date-time) | ISO 8601 timestamp |
ends_atrequired | string (date-time) | ISO 8601 timestamp |
statusrequired | string (enum) | Where the booking is in its lifescheduledconfirmedcompletedno_showcancelled |
sourcerequired | string (enum) | Who booked it: staff in the dashboard, the AI assistant, the public booking page, or this APIstaffaipublicapi |
cancel_reasonrequired | string | null | What was recorded when it was cancelled |
completed_atrequired | string (date-time) | null | When it was marked completed |
created_atrequired | string (date-time) | ISO 8601 timestamp |
updated_atrequired | string (date-time) | ISO 8601 timestamp |
Endpoints
8 endpoints, each on its own page with its parameters, responses, error codes and samples in curl, Node and Python.