CancelledBookings
Search CancelledBookings
Search and list CancelledBooking records with filtering, sorting, and pagination.
GET
Search CancelledBookings
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-List role.Enums
eBookingCancellationReason
eBookingCancellationReason
eBookingRepeatCycle — Repeats values
eBookingRepeatCycle — Repeats values
eRepeatedBookingUpdateAction — WhichBookingsToUpdate values
eRepeatedBookingUpdateAction — WhichBookingsToUpdate values
Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the resource linked to this record.
string
Filter by resource name.
integer
Filter by the resource allocation value for this cancelled booking.
boolean
Filter by whether resource hide in calendar is enabled.
integer
Filter by the resource no return policy value for this cancelled booking.
integer
Filter by the resource no return policy all resources value for this cancelled booking.
integer
Filter by the resource no return policy all users value for this cancelled booking.
integer
Filter by iD of the resource resource type associated with this record.
string
Filter by display name of the linked resource resource type (read-only).
integer
Filter by iD of the floor plan desk linked to this record.
string
Filter by display name of the linked floor plan desk (read-only).
integer
Filter by iD of the coworker linked to this record.
string
Filter by the coworker coworker type value for this cancelled booking.
string
Filter by coworker full name.
string
Filter by coworker billing name.
string
Filter by coworker company name.
string
Filter by the coworker team names value for this cancelled booking.
integer
Filter by iD of the extra service linked to this record.
string
Filter by extra service name.
string
Filter by booking start time.
string
Filter by booking end time.
string
Filter by optional notes or comments about this cancelled booking.
string
Filter by the internal notes value for this cancelled booking.
boolean
Filter by whether charge now is enabled.
boolean
Filter by whether invoice now is enabled.
boolean
Filter by whether invoice this coworker is enabled.
boolean
Filter by whether do not use booking credit is enabled.
string
Filter by the purchase order value for this cancelled booking.
string
Filter by the discount code value for this cancelled booking.
string
Filter by date/time value for last notification time.
string
Filter by iD of the google calendar associated with this record.
string
Filter by iD of the google event associated with this record.
string
Filter by iD of the office365 event associated with this record.
string
Filter by iD of the public google event associated with this record.
boolean
Filter by tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
boolean
Filter by whether online is enabled.
string
Filter by the teams at the time of booking value for this cancelled booking.
string
Filter by the tariff at the time of booking value for this cancelled booking.
string
Filter by iD of the repeat series unique associated with this record.
boolean
Filter by whether repeat booking is enabled.
integer
Filter by the repeats value for this cancelled booking.
integer
Filter by date/time value for which bookings to update.
integer
Filter by the repeat every value for this cancelled booking.
string
Filter by date/time value for repeat until.
boolean
Filter by whether repeat on mondays is enabled.
boolean
Filter by whether repeat on tuesdays is enabled.
boolean
Filter by whether repeat on wednesdays is enabled.
boolean
Filter by whether repeat on thursdays is enabled.
boolean
Filter by whether repeat on fridays is enabled.
boolean
Filter by whether repeat on saturdays is enabled.
boolean
Filter by whether repeat on sundays is enabled.
boolean
Filter by whether reminded is enabled.
boolean
Filter by whether mrm reminded is enabled.
number
Filter by the override price value for this cancelled booking.
boolean
Filter by whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account.
string
Filter by date/time value for invoice date.
integer
Filter by the booking number value for this cancelled booking.
integer
Filter by iD of the kisi key associated with this record.
string
Filter by iD of the start scheduled job associated with this record.
string
Filter by iD of the end scheduled job associated with this record.
boolean
Filter by whether billed is enabled.
string
Filter by date/time value for from time local.
string
Filter by date/time value for to time local.
string
Filter by date/time value for invoice date local.
integer
Filter by iD of the coworker invoice associated with this record.
string
Filter by the coworker invoice number value for this cancelled booking.
boolean
Filter by whether coworker invoice paid is enabled.
boolean
Filter by whether coworker invoice draft is enabled.
boolean
Filter by whether coworker invoice void is enabled.
boolean
Filter by whether coworker invoice credit note is enabled.
string
Filter by the coworker extra service ids value for this cancelled booking.
number
Filter by the coworker extra service price value for this cancelled booking.
string
Filter by the coworker extra service currency code value for this cancelled booking.
integer
Filter by the coworker extra service charge period value for this cancelled booking.
integer
Filter by the coworker extra service total uses value for this cancelled booking.
boolean
Filter by whether include zoom invite is enabled.
string
Filter by the zoom event data value for this cancelled booking.
string
Filter by date/time value for checked in at.
boolean
Filter by whether cancel if not paid is enabled.
boolean
Filter by whether cancel if not checked in is enabled.
integer
Filter by the max occupancy value for this cancelled booking.
number
Filter by the last minute price adjustment value for this cancelled booking.
number
Filter by the dynamic price adjustment value for this cancelled booking.
number
Filter by the price factor last minute value for this cancelled booking.
number
Filter by the price factor demand value for this cancelled booking.
string
Filter by iD of the office365 admin event associated with this record.
integer
Filter by reason the booking was cancelled, e.g. NoLongerNeeded, TooExpensive, or NotCheckedIn.
string
Filter by date and time when the booking was cancelled.
string
Filter by name or identifier of the user who cancelled the booking.
string
Filter by additional free-text details explaining the cancellation reason.
number
Filter by booking price.
string
Filter by iD of the original booking associated with this record.
Range Filters
integer
Filter by the resource allocation value for this cancelled booking greater than or equal to this value.
integer
Filter by the resource allocation value for this cancelled booking less than or equal to this value.
integer
Filter by the resource no return policy value for this cancelled booking greater than or equal to this value.
integer
Filter by the resource no return policy value for this cancelled booking less than or equal to this value.
integer
Filter by the resource no return policy all resources value for this cancelled booking greater than or equal to this value.
integer
Filter by the resource no return policy all resources value for this cancelled booking less than or equal to this value.
integer
Filter by the resource no return policy all users value for this cancelled booking greater than or equal to this value.
integer
Filter by the resource no return policy all users value for this cancelled booking less than or equal to this value.
integer
Filter by iD of the resource resource type associated with this record greater than or equal to this value.
integer
Filter by iD of the resource resource type associated with this record less than or equal to this value.
string
Filter by booking start time greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by booking start time less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by booking end time greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by booking end time less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for last notification time greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for last notification time less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by the repeat every value for this cancelled booking greater than or equal to this value.
integer
Filter by the repeat every value for this cancelled booking less than or equal to this value.
string
Filter by date/time value for repeat until greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for repeat until less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.number
Filter by the override price value for this cancelled booking greater than or equal to this value.
number
Filter by the override price value for this cancelled booking less than or equal to this value.
string
Filter by date/time value for invoice date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for invoice date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by the booking number value for this cancelled booking greater than or equal to this value.
integer
Filter by the booking number value for this cancelled booking less than or equal to this value.
integer
Filter by iD of the kisi key associated with this record greater than or equal to this value.
integer
Filter by iD of the kisi key associated with this record less than or equal to this value.
string
Filter by date/time value for from time local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for from time local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for to time local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for to time local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for invoice date local greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for invoice date local less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by iD of the coworker invoice associated with this record greater than or equal to this value.
integer
Filter by iD of the coworker invoice associated with this record less than or equal to this value.
number
Filter by the coworker extra service price value for this cancelled booking greater than or equal to this value.
number
Filter by the coworker extra service price value for this cancelled booking less than or equal to this value.
integer
Filter by the coworker extra service charge period value for this cancelled booking greater than or equal to this value.
integer
Filter by the coworker extra service charge period value for this cancelled booking less than or equal to this value.
integer
Filter by the coworker extra service total uses value for this cancelled booking greater than or equal to this value.
integer
Filter by the coworker extra service total uses value for this cancelled booking less than or equal to this value.
string
Filter by date/time value for checked in at greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for checked in at less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.integer
Filter by the max occupancy value for this cancelled booking greater than or equal to this value.
integer
Filter by the max occupancy value for this cancelled booking less than or equal to this value.
number
Filter by the last minute price adjustment value for this cancelled booking greater than or equal to this value.
number
Filter by the last minute price adjustment value for this cancelled booking less than or equal to this value.
number
Filter by the dynamic price adjustment value for this cancelled booking greater than or equal to this value.
number
Filter by the dynamic price adjustment value for this cancelled booking less than or equal to this value.
number
Filter by the price factor last minute value for this cancelled booking greater than or equal to this value.
number
Filter by the price factor last minute value for this cancelled booking less than or equal to this value.
number
Filter by the price factor demand value for this cancelled booking greater than or equal to this value.
number
Filter by the price factor demand value for this cancelled booking less than or equal to this value.
string
Filter by date and time when the booking was cancelled greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date and time when the booking was cancelled less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.number
Filter by booking price greater than or equal to this value.
number
Filter by booking price less than or equal to this value.
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
CancelledBooking[]
The list of CancelledBooking records matching the query. See the Get one CancelledBooking endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response
Search CancelledBookings