Availability

Get availability details for a date

Returns an exhaustive availability snapshot for a single site/date, combining opening hours, calendar availability, practitioner and room schedules, equipment, and the periods already occupied by existing bookings or blocks.

The endpoint powers Trybe's calendar day view and the booking workflow's "explain" panel — the same payload is used to render why a slot is or isn't bookable.

Scope the response to a single offering by supplying both offering_type and offering_id. When omitted, the response includes every practitioner, room and equipment item at the site and skips offering-specific calendars.

The current user must have the reservations.manage permission on the site to call this endpoint.

get/shop/availability-details

Query parameters

site_idstring required

Filter results by the site they belong to

datestring date-time required

The date on which to inspect availability. Expressed as an ISO-8601 date-time anchored in the site's local timezone. Only the date portion is significant — the endpoint always returns availability for the full day.

offering_type'appointment' | 'area_booking' | 'session' | 'course' | 'product' | 'package' | 'voucher'

The type of offering to scope availability to. Required when offering_id is provided. When omitted, the response includes every practitioner, room and equipment item at the site and skips offering-specific calendars.

offering_idstring object-id

The identifier of an offering (e.g. an AppointmentType or AreaBookingType) to focus the response on. When supplied together with offering_type, the response includes the offering's calendar availability and only the practitioners, rooms and equipment associated with that offering.

Response

The availability details were successfully retrieved.

Changes