Skip to main content
GET
Search CancelledBookings
A cancelled booking is the audit snapshot created when a resource reservation is cancelled, preserving its resource, customer, time, price, and cancellation reason for reporting.

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

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 that was reserved; it determines the cancelled booking’s location..
string
Filter by display value for Resource.Name..
integer
Filter by display value for Resource.Allocation..
boolean
Filter by display value for Resource.HideInCalendar..
integer
Filter by display value for Resource.NoReturnPolicy..
integer
Filter by display value for Resource.NoReturnPolicyAllResources..
integer
Filter by display value for Resource.NoReturnPolicyAllUsers..
integer
Filter by display value for Resource.ResourceType.Id..
string
Filter by display value for Resource.ResourceType.Name..
integer
Filter by optional ID of the floor-plan unit assigned within the resource when the booking was cancelled..
string
Filter by display value for FloorPlanDesk.Name..
integer
Filter by optional ID of the customer whose booking was cancelled..
string
Filter by display value for Coworker.CoworkerType..
string
Filter by display value for Coworker.FullName..
string
Filter by display value for Coworker.BillingName..
string
Filter by display value for Coworker.CompanyName..
string
Filter by display value for Coworker.TeamNames..
integer
Filter by optional ID of the booking rate used when the cancelled booking was priced..
string
Filter by display value for ExtraService.Name..
string
Filter by uTC date and time when the cancelled booking began..
string
Filter by uTC date and time when the cancelled booking ended; it is after FromTime..
string
Filter by customer-facing notes retained from the cancelled booking..
string
Filter by internal staff notes retained from the cancelled booking..
boolean
Filter by whether the original booking was requested to be charged immediately..
boolean
Filter by whether the original booking was requested to generate an invoice immediately..
boolean
Filter by whether the selected customer was the billing party for the original booking..
boolean
Filter by whether customer booking credit was prevented from being used for the original booking..
string
Filter by customer purchase-order reference retained from the cancelled booking..
string
Filter by discount code retained from the cancelled booking..
string
Filter by internal UTC timestamp maintained for the last booking notification..
string
Filter by internal Google Calendar identifier maintained by calendar synchronization..
string
Filter by internal Google Calendar event identifier maintained by calendar synchronization..
string
Filter by internal Microsoft 365 calendar event identifier maintained by synchronization..
string
Filter by internal public Google Calendar event identifier maintained by synchronization..
boolean
Filter by whether the cancelled booking was tentative and awaiting confirmation; tentative bookings still blocked the calendar..
boolean
Filter by whether the cancelled booking was for an online resource..
string
Filter by system snapshot of the customer’s team memberships when the cancelled booking was made..
string
Filter by system snapshot of the customer’s plan when the cancelled booking was made..
string
Filter by system-generated identifier linking bookings from the same recurrence series..
boolean
Filter by whether the cancelled booking was created as part of a recurrence series..
integer
Filter by recurrence cycle retained from the booking: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth..
integer
Filter by original recurrence action: UpdateThisBookingOnly, UpdateFutureBookingsOnly, UpdateAllBookings, UpdateNotChargedBookings, DeleteAllBookings, DeleteBookingsAfterThis, DeleteNotChargedBookings, or RevertAllCharges..
integer
Filter by recurrence interval retained from the booking; for example, 2 with Weekly means every two weeks..
string
Filter by final UTC date and time for creating occurrences in the original recurrence series..
boolean
Filter by whether the original weekly recurrence included Mondays..
boolean
Filter by whether the original weekly recurrence included Tuesdays..
boolean
Filter by whether the original weekly recurrence included Wednesdays..
boolean
Filter by whether the original weekly recurrence included Thursdays..
boolean
Filter by whether the original weekly recurrence included Fridays..
boolean
Filter by whether the original weekly recurrence included Saturdays..
boolean
Filter by whether the original weekly recurrence included Sundays..
boolean
Filter by system flag showing whether the standard booking reminder had been sent..
boolean
Filter by system flag showing whether an MRM reminder had been sent..
number
Filter by optional total price override retained from the original booking, before normal rate calculation..
boolean
Filter by whether a charge was posted to the customer account for the original booking; it does not indicate invoice status..
string
Filter by uTC date and time when the original booking was charged..
integer
Filter by system-generated reference number retained from the original booking..
integer
Filter by internal Kisi access-control key identifier retained from the original booking..
string
Filter by internal scheduled-job identifier for the original booking start..
string
Filter by internal scheduled-job identifier for the original booking end..
boolean
Filter by internal billing-processing state retained from the original booking..
string
Filter by system-maintained local-time representation of FromTime..
string
Filter by system-maintained local-time representation of ToTime..
string
Filter by system-maintained local-time representation of InvoiceDate..
integer
Filter by iD of the invoice associated with the original booking; manage it through the invoice entity..
string
Filter by invoice number associated with the original booking, when it was included in an invoice..
boolean
Filter by whether the invoice associated with the original booking has been paid..
boolean
Filter by whether the invoice associated with the original booking is a draft..
boolean
Filter by whether the invoice associated with the original booking has been voided..
boolean
Filter by whether the invoice associated with the original booking is a credit note..
string
Filter by internal serialized identifiers of customer rate entitlements used by the original booking..
number
Filter by system-calculated price from the customer’s applicable booking rate entitlement..
string
Filter by read-only system-calculated currency code for the customer rate entitlement used by the original booking..
integer
Filter by system-calculated charge-period setting for the customer rate entitlement used by the original booking..
integer
Filter by system-calculated number of customer rate uses consumed or available for the original booking..
boolean
Filter by whether the original booking included a Zoom meeting invitation..
string
Filter by internal Zoom event payload maintained by the integration..
string
Filter by uTC date and time when the original booking was checked in through the booking workflow..
boolean
Filter by whether the resource policy cancelled the booking when payment was not received..
boolean
Filter by whether the resource policy cancelled the booking when no check-in occurred..
integer
Filter by maximum occupancy detected by sensors in the resource during the original booking..
number
Filter by system-calculated monetary dynamic-pricing adjustment applied for a last-minute booking..
number
Filter by system-calculated monetary adjustment from dynamic-pricing settings for the resource or location..
number
Filter by system-calculated multiplier used for the last-minute dynamic-pricing adjustment..
number
Filter by system-calculated multiplier used for demand-based dynamic pricing..
string
Filter by internal Microsoft 365 administrator calendar event identifier maintained by synchronization..
integer
Filter by reason the booking was cancelled: Unknown, NoLongerNeeded, TooExpensive, BadPreviousExperience, RebookedForADifferentTime, FailedToPayUpfront, Integration, Other, NotCheckedIn, or MarketPlace..
string
Filter by uTC date and time when the booking was cancelled..
string
Filter by name or identifier supplied by the user or process that cancelled the booking..
string
Filter by optional free-text details explaining the cancellation reason, up to 255 characters..
number
Filter by final calculated price of the booking at cancellation, including the system’s booking cost calculation..
string
Filter by gUID of the original booking from which this cancellation record was created..
string
Filter by date and time when the customer checked in to this booking (before it was cancelled).
string
Filter by date and time when the customer checked out from this booking (before it was cancelled).

Range Filters

integer
Filter by display value for Resource.Allocation. greater than or equal to this value.
integer
Filter by display value for Resource.Allocation. less than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicy. greater than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicy. less than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllResources. greater than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllResources. less than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllUsers. greater than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllUsers. less than or equal to this value.
integer
Filter by display value for Resource.ResourceType.Id. greater than or equal to this value.
integer
Filter by display value for Resource.ResourceType.Id. less than or equal to this value.
string
Filter by uTC date and time when the cancelled booking began. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the cancelled booking began. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the cancelled booking ended; it is after FromTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the cancelled booking ended; it is after FromTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by internal UTC timestamp maintained for the last booking notification. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by internal UTC timestamp maintained for the last booking notification. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by recurrence interval retained from the booking; for example, 2 with Weekly means every two weeks. greater than or equal to this value.
integer
Filter by recurrence interval retained from the booking; for example, 2 with Weekly means every two weeks. less than or equal to this value.
string
Filter by final UTC date and time for creating occurrences in the original recurrence series. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by final UTC date and time for creating occurrences in the original recurrence series. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
number
Filter by optional total price override retained from the original booking, before normal rate calculation. greater than or equal to this value.
number
Filter by optional total price override retained from the original booking, before normal rate calculation. less than or equal to this value.
string
Filter by uTC date and time when the original booking was charged. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the original booking was charged. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by system-generated reference number retained from the original booking. greater than or equal to this value.
integer
Filter by system-generated reference number retained from the original booking. less than or equal to this value.
integer
Filter by internal Kisi access-control key identifier retained from the original booking. greater than or equal to this value.
integer
Filter by internal Kisi access-control key identifier retained from the original booking. less than or equal to this value.
string
Filter by system-maintained local-time representation of FromTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of FromTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of ToTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of ToTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of InvoiceDate. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of InvoiceDate. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by iD of the invoice associated with the original booking; manage it through the invoice entity. greater than or equal to this value.
integer
Filter by iD of the invoice associated with the original booking; manage it through the invoice entity. less than or equal to this value.
number
Filter by system-calculated price from the customer’s applicable booking rate entitlement. greater than or equal to this value.
number
Filter by system-calculated price from the customer’s applicable booking rate entitlement. less than or equal to this value.
integer
Filter by system-calculated charge-period setting for the customer rate entitlement used by the original booking. greater than or equal to this value.
integer
Filter by system-calculated charge-period setting for the customer rate entitlement used by the original booking. less than or equal to this value.
integer
Filter by system-calculated number of customer rate uses consumed or available for the original booking. greater than or equal to this value.
integer
Filter by system-calculated number of customer rate uses consumed or available for the original booking. less than or equal to this value.
string
Filter by uTC date and time when the original booking was checked in through the booking workflow. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the original booking was checked in through the booking workflow. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by maximum occupancy detected by sensors in the resource during the original booking. greater than or equal to this value.
integer
Filter by maximum occupancy detected by sensors in the resource during the original booking. less than or equal to this value.
number
Filter by system-calculated monetary dynamic-pricing adjustment applied for a last-minute booking. greater than or equal to this value.
number
Filter by system-calculated monetary dynamic-pricing adjustment applied for a last-minute booking. less than or equal to this value.
number
Filter by system-calculated monetary adjustment from dynamic-pricing settings for the resource or location. greater than or equal to this value.
number
Filter by system-calculated monetary adjustment from dynamic-pricing settings for the resource or location. less than or equal to this value.
number
Filter by system-calculated multiplier used for the last-minute dynamic-pricing adjustment. greater than or equal to this value.
number
Filter by system-calculated multiplier used for the last-minute dynamic-pricing adjustment. less than or equal to this value.
number
Filter by system-calculated multiplier used for demand-based dynamic pricing. greater than or equal to this value.
number
Filter by system-calculated multiplier used for demand-based dynamic pricing. less than or equal to this value.
string
Filter by uTC date and time when the booking was cancelled. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the booking was cancelled. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
number
Filter by final calculated price of the booking at cancellation, including the system’s booking cost calculation. greater than or equal to this value.
number
Filter by final calculated price of the booking at cancellation, including the system’s booking cost calculation. less than or equal to this value.
string
Filter by date and time when the customer checked in to this booking (before it was cancelled) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date and time when the customer checked in to this booking (before it was cancelled) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date and time when the customer checked out from this booking (before it was cancelled) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by date and time when the customer checked out from this booking (before it was cancelled) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
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.
Partial records — The listing endpoint returns a summary representation of each CancelledBooking. The following fields are not populated in the Records[] response: InternalNotes, ChargeNow, InvoiceNow, InvoiceThisCoworker, DoNotUseBookingCredit, RepeatBooking, Repeats, WhichBookingsToUpdate, RepeatEvery, RepeatUntil, RepeatOnMondays, RepeatOnTuesdays, RepeatOnWednesdays, RepeatOnThursdays, RepeatOnFridays, RepeatOnSaturdays, RepeatOnSundays, OverridePrice, InvoiceDate, IncludeZoomInvite.To get all fields, fetch the full record using the Get one CancelledBooking endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
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