Sign in
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

Changes

Changed in 7 of the 32 revisions of this API.61721

  • v23535cc88f4072See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • v2bc14ea8f3d374See the full diff
    • ○

      added the new optional query request parameter page

      new-optional-request-parameter

    • ○

      added the new optional query request parameter per_page

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort_by

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort_order

      new-optional-request-parameter

  • v2ecce040ff5002See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • v2aaf71a5c21815See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • v2b0215746332216See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

  • v29331d0ba953811See the full diff
    • ▲

      the / response's property type changed from float to number for status

      response-property-type-changed

    • ○

      the response property // became required for the status

      response-property-became-required

  • v295c52cb13f9a5161See the full diff
    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the / response's property type changed from number to float for status

      response-property-type-changed

    • ●

      deleted the query request parameter page

      request-parameter-removed

    • ●

      deleted the query request parameter per_page

      request-parameter-removed

    • ●

      deleted the query request parameter sort_by

      request-parameter-removed

    • ●

      deleted the query request parameter sort_order

      request-parameter-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog