JAjammed-org
Booking - Core

Find a booking by code

Changed on

Returns booking with the given code.

Pass include=cancellation_link to also get cancellation_link: a pre-validated link that takes the customer straight to the step where they confirm cancelling, without the usual email check. It is valid for 30 minutes and lets whoever holds it cancel the booking as the customer, so only hand it to the customer. Each request mints a fresh link and is never answered with 304 Not Modified. OAuth tokens need bookings.write to ask for it.

get/bookings/{code}.json

Request

  • Base URL
    https://api.jammed.app/api/v2
  • Auth
    none declared. Required headers: Authorization

Path parameters

codestring required

The booking code

Query parameters

include'cancellation_link'

Set to cancellation_link to add a pre-validated cancellation link to the response

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

Example response

{
  "cancellation_link": {
    "url": "https://studio.jammed.app/reserved?booking=ABC123&hash=...&validation=...",
    "expires_at": 1762352400
  }
}

Changes

  • v2a7e302411d13Revision changes
    • info

      api tag Booking - Core added

    • info

      api tag Booking Endpoints removed

  • v2af12cab9caa4Revision changes
    • info

      added the new optional query request parameter include

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status