Sign in
Booking Endpoints

Finished bookings

Returns all bookings that have not yet ended, ordered by start time descending. Supports pagination.

get/bookings/finished.json

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 6 of the 32 revisions of this API.61319

  • v23535cc88f4072See the full diff
    • ○

      added the optional property items/group/booking_count to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/group/number to the response with the 200 status

      response-optional-property-added

  • v2ecce040ff5002See the full diff
    • ○

      added the optional property items/custom_answers to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/source_data to the response with the 200 status

      response-optional-property-added

  • v2aaf71a5c21815See the full diff
    • ○

      added the optional property items/activity_name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/approved_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/cancelled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/online_booking to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/rejected_at to the response with the 200 status

      response-optional-property-added

  • v2b0215746332216See the full diff
    • ●

      removed the optional property items/number_expected from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property items/dates to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/extras to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      the response property items/customer/email became required for the status 200

      response-property-became-required

    • ○

      the response property items/group/code became required for the status 200

      response-property-became-required

    • ○

      the response property items/room/code became required for the status 200

      response-property-became-required

  • v29331d0ba953812See the full diff
    • ▲

      the items/duration_hours response's property type/format changed from float/ to number/ for status 200

      response-property-type-changed

    • ○

      api operation id getBookingsStarted removed and replaced with getBookingsFinished

      api-operation-id-removed

    • ○

      the response property items/group/name became required for the status 200

      response-property-became-required

  • v295c52cb13f9a5122See the full diff
    • ▲

      the response property items/customer/email became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/group/code became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/group/name became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/room/code became optional for the status 200

      response-property-became-optional

    • ▲

      the items/duration_hours response's property type/format changed from number/ to float/ for status 200

      response-property-type-changed

    • ●

      removed the optional property items/activity_name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/approved_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/cancelled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/custom_answers from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/dates from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/extras from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/group/booking_count from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/group/number from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/online_booking from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/rejected_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/source_data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/timezone from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id getBookingsFinished removed and replaced with getBookingsStarted

      api-operation-id-removed

    • ○

      added the optional property items/number_expected to the response with the 200 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