CancelledBookings
Get one CancelledBooking
Retrieve a single CancelledBooking record by its Id.
GET
Get one CancelledBooking
A CancelledBooking is a read-only snapshot of a booking that was removed from the calendar. When a booking is cancelled, the system preserves its details — resource, coworker, time range, price, and cancellation metadata — so they remain available for reporting and auditing.
Cancelled bookings cannot be created or modified through the API; they are generated automatically when an active
Booking is cancelled. Use list and get to query cancellation history.
The CancellationReason field indicates why the booking was removed. Possible reasons include the customer no longer needing the booking, cost concerns, rebooking for a different time, failure to pay upfront, automated cancellation due to not checking in, and others.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CancelledBooking-Read role.Path Parameters
integer
required
The Id of the CancelledBooking record to retrieve.
Code Examples
Response
200
integer
ID of the resource linked to this record.
string
Resource name.
integer
The resource allocation value for this cancelled booking.
boolean
Whether resource hide in calendar is enabled.
integer
The resource no return policy value for this cancelled booking.
integer
The resource no return policy all resources value for this cancelled booking.
integer
The resource no return policy all users value for this cancelled booking.
integer
ID of the resource resource type associated with this record.
string
Display name of the linked resource resource type (read-only).
integer
ID of the floor plan desk linked to this record.
string
Display name of the linked floor plan desk (read-only).
integer
ID of the coworker linked to this record.
string
The coworker coworker type value for this cancelled booking.
string
Coworker full name.
string
Coworker billing name.
string
Coworker company name.
string
The coworker team names value for this cancelled booking.
integer
ID of the extra service linked to this record.
string
Extra service name.
string
Booking start time.
string
Booking end time.
string
Optional notes or comments about this cancelled booking.
string
The internal notes value for this cancelled booking.
boolean
Whether charge now is enabled.
boolean
Whether invoice now is enabled.
boolean
Whether invoice this coworker is enabled.
boolean
Whether do not use booking credit is enabled.
string
The purchase order value for this cancelled booking.
string
The discount code value for this cancelled booking.
string
Date/time value for last notification time.
string
ID of the google calendar associated with this record.
string
ID of the google event associated with this record.
string
ID of the office365 event associated with this record.
string
ID of the public google event associated with this record.
boolean
Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
boolean
Whether online is enabled.
string
The teams at the time of booking value for this cancelled booking.
string
The tariff at the time of booking value for this cancelled booking.
string
ID of the repeat series unique associated with this record.
boolean
Whether repeat booking is enabled.
integer
The repeats value for this cancelled booking. See
eBookingRepeatCycle enum values: 1 = Daily, 2 = Weekly, 3 = Monthly, 4 = Yearly, 5 = FirstOfMonth, 6 = SecondOfMonth, 7 = ThirdOfMonth, 8 = LastOfMonth, 9 = FourthOfMonth.integer
Date/time value for which bookings to update. See
eRepeatedBookingUpdateAction enum values: 1 = UpdateThisBookingOnly, 2 = UpdateFutureBookingsOnly, 3 = UpdateAllBookings, 4 = UpdateNotChargedBookings, 5 = DeleteAllBookings, 6 = DeleteBookingsAfterThis, 7 = DeleteNotChargedBookings, 8 = RevertAllCharges.integer
The repeat every value for this cancelled booking.
string
Date/time value for repeat until.
boolean
Whether repeat on mondays is enabled.
boolean
Whether repeat on tuesdays is enabled.
boolean
Whether repeat on wednesdays is enabled.
boolean
Whether repeat on thursdays is enabled.
boolean
Whether repeat on fridays is enabled.
boolean
Whether repeat on saturdays is enabled.
boolean
Whether repeat on sundays is enabled.
boolean
Whether reminded is enabled.
boolean
Whether mrm reminded is enabled.
number
The override price value for this cancelled booking.
boolean
Whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account.
string
Date/time value for invoice date.
integer
The booking number value for this cancelled booking.
integer
ID of the kisi key associated with this record.
string
ID of the start scheduled job associated with this record.
string
ID of the end scheduled job associated with this record.
boolean
Whether billed is enabled.
string
Date/time value for from time local.
string
Date/time value for to time local.
string
Date/time value for invoice date local.
integer
ID of the coworker invoice associated with this record.
string
The coworker invoice number value for this cancelled booking.
boolean
Whether coworker invoice paid is enabled.
boolean
Whether coworker invoice draft is enabled.
boolean
Whether coworker invoice void is enabled.
boolean
Whether coworker invoice credit note is enabled.
string
The coworker extra service ids value for this cancelled booking.
number
The coworker extra service price value for this cancelled booking.
string
The coworker extra service currency code value for this cancelled booking.
integer
The coworker extra service charge period value for this cancelled booking.
integer
The coworker extra service total uses value for this cancelled booking.
boolean
Whether include zoom invite is enabled.
string
The zoom event data value for this cancelled booking.
string
Date/time value for checked in at.
boolean
Whether cancel if not paid is enabled.
boolean
Whether cancel if not checked in is enabled.
integer
The max occupancy value for this cancelled booking.
number
The last minute price adjustment value for this cancelled booking.
number
The dynamic price adjustment value for this cancelled booking.
number
The price factor last minute value for this cancelled booking.
number
The price factor demand value for this cancelled booking.
string
ID of the office365 admin event associated with this record.
integer
Reason the booking was cancelled, e.g. NoLongerNeeded, TooExpensive, or NotCheckedIn.
string
Date and time when the booking was cancelled.
string
Name or identifier of the user who cancelled the booking.
string
Additional free-text details explaining the cancellation reason.
number
Booking price.
string
ID of the original booking associated with this record.
integer
Unique record identifier.
string
UUID of the record.
string
Date and time the record was created (ISO 8601).
string
Date and time the record was last updated (ISO 8601).
string
Email of the user who last updated this record.
boolean
Whether the record was recently created.
string
External system identifier.
Example Response
Get one CancelledBooking