Sign in

v1

latestOpenAPI 3.0.2Jammed Bookings2026-07-147540124.9 KB
Booking Endpoints

All bookings

Returns all non-cancelled bookings with optional sorting and pagination support.

get/bookings.json

Query parameters

sort_by'created_at' | 'updated_at' | 'start_at' | 'end_at' | 'customer_name' | 'room_name'

Field to sort by

sort_order'asc' | 'desc'

Sort order (ascending or descending)

pageinteger

Page number for pagination

per_pageinteger

Number of items per page

Headers

Authorizationstring required

Response

successful operation

codestring

The code of the booking - seen by customers on the booking page

idstring

Same as code

recordingboolean

Whether the room has been marked as a recording

regularboolean

Whether the booking is part of a regular booking

online_bookingboolean

Whether the booking was made online by the customer

created_atinteger

Unix timestamp from epoch

updated_atinteger

Unix timestamp from epoch

approved_atinteger

Unix timestamp from epoch - when the booking was approved (if approved)

rejected_atinteger

Unix timestamp from epoch - when the booking was rejected (if rejected)

priceinteger

The price of the booking time only in cents/pence/units

price_currencystring

The currency of the price

titlestring

The title of the booking - this is generated from the customer and group names

start_atinteger

Unix timestamp from epoch

end_atinteger

Unix timestamp from epoch

durationinteger

The duration of the booking in seconds

duration_hoursnumber

The duration of the booking in hours, e.g. 1pm-2.30pm = 2.5 hours

duration_full_hoursinteger

The duration of the booking in hours, rounded up to each full hour, e.g. 1pm-2.30pm = 3 hours

activity_namestring

The name of the activity the booking is part of - e.g. 'Rehearsal'

datesstring[]

The dates that the booking is part of in local time - given as strings YYYYMMDD format

timezonestring

The timezone of the booking

has_amount_dueboolean

Whether the booking still has an amount due

remaining_amountinteger

The remaining amount due for the booking

cancelledboolean

Whether the booking has been cancelled

taken_bystring

The name of the staff member who took the booking - if null, the booking was made by the customer themselves