> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search CancelledBookings > Search and list CancelledBooking records with filtering, sorting, and pagination. 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 | Value | Name | | ----- | ------------------------- | | 0 | Unknown | | 1 | NoLongerNeeded | | 2 | TooExpensive | | 3 | BadPreviousExperience | | 4 | RebookedForADifferentTime | | 5 | FailedToPayUpfront | | 6 | Integration | | 7 | Other | | 8 | NotCheckedIn | | 9 | MarketPlace | | Value | Name | | ----- | ------------- | | 1 | Daily | | 2 | Weekly | | 3 | Monthly | | 4 | Yearly | | 5 | FirstOfMonth | | 6 | SecondOfMonth | | 7 | ThirdOfMonth | | 8 | LastOfMonth | | 9 | FourthOfMonth | | Value | Name | | ----- | ------------------------ | | 1 | UpdateThisBookingOnly | | 2 | UpdateFutureBookingsOnly | | 3 | UpdateAllBookings | | 4 | UpdateNotChargedBookings | | 5 | DeleteAllBookings | | 6 | DeleteBookingsAfterThis | | 7 | DeleteNotChargedBookings | | 8 | RevertAllCharges | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by iD of the resource linked to this record. Filter by resource name. Filter by the resource allocation value for this cancelled booking. Filter by whether resource hide in calendar is enabled. Filter by the resource no return policy value for this cancelled booking. Filter by the resource no return policy all resources value for this cancelled booking. Filter by the resource no return policy all users value for this cancelled booking. Filter by iD of the resource resource type associated with this record. Filter by display name of the linked resource resource type (read-only). Filter by iD of the floor plan desk linked to this record. Filter by display name of the linked floor plan desk (read-only). Filter by iD of the coworker linked to this record. Filter by the coworker coworker type value for this cancelled booking. Filter by coworker full name. Filter by coworker billing name. Filter by coworker company name. Filter by the coworker team names value for this cancelled booking. Filter by iD of the extra service linked to this record. Filter by extra service name. Filter by booking start time. Filter by booking end time. Filter by optional notes or comments about this cancelled booking. Filter by the internal notes value for this cancelled booking. Filter by whether charge now is enabled. Filter by whether invoice now is enabled. Filter by whether invoice this coworker is enabled. Filter by whether do not use booking credit is enabled. Filter by the purchase order value for this cancelled booking. Filter by the discount code value for this cancelled booking. Filter by date/time value for last notification time. Filter by iD of the google calendar associated with this record. Filter by iD of the google event associated with this record. Filter by iD of the office365 event associated with this record. Filter by iD of the public google event associated with this record. Filter by tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar. Filter by whether online is enabled. Filter by the teams at the time of booking value for this cancelled booking. Filter by the tariff at the time of booking value for this cancelled booking. Filter by iD of the repeat series unique associated with this record. Filter by whether repeat booking is enabled. Filter by the repeats value for this cancelled booking. Filter by date/time value for which bookings to update. Filter by the repeat every value for this cancelled booking. Filter by date/time value for repeat until. Filter by whether repeat on mondays is enabled. Filter by whether repeat on tuesdays is enabled. Filter by whether repeat on wednesdays is enabled. Filter by whether repeat on thursdays is enabled. Filter by whether repeat on fridays is enabled. Filter by whether repeat on saturdays is enabled. Filter by whether repeat on sundays is enabled. Filter by whether reminded is enabled. Filter by whether mrm reminded is enabled. Filter by the override price value for this cancelled booking. Filter by whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account. Filter by date/time value for invoice date. Filter by the booking number value for this cancelled booking. Filter by iD of the kisi key associated with this record. Filter by iD of the start scheduled job associated with this record. Filter by iD of the end scheduled job associated with this record. Filter by whether billed is enabled. Filter by date/time value for from time local. Filter by date/time value for to time local. Filter by date/time value for invoice date local. Filter by iD of the coworker invoice associated with this record. Filter by the coworker invoice number value for this cancelled booking. Filter by whether coworker invoice paid is enabled. Filter by whether coworker invoice draft is enabled. Filter by whether coworker invoice void is enabled. Filter by whether coworker invoice credit note is enabled. Filter by the coworker extra service ids value for this cancelled booking. Filter by the coworker extra service price value for this cancelled booking. Filter by the coworker extra service currency code value for this cancelled booking. Filter by the coworker extra service charge period value for this cancelled booking. Filter by the coworker extra service total uses value for this cancelled booking. Filter by whether include zoom invite is enabled. Filter by the zoom event data value for this cancelled booking. Filter by date/time value for checked in at. Filter by whether cancel if not paid is enabled. Filter by whether cancel if not checked in is enabled. Filter by the max occupancy value for this cancelled booking. Filter by the last minute price adjustment value for this cancelled booking. Filter by the dynamic price adjustment value for this cancelled booking. Filter by the price factor last minute value for this cancelled booking. Filter by the price factor demand value for this cancelled booking. Filter by iD of the office365 admin event associated with this record. Filter by reason the booking was cancelled, e.g. NoLongerNeeded, TooExpensive, or NotCheckedIn. Filter by date and time when the booking was cancelled. Filter by name or identifier of the user who cancelled the booking. Filter by additional free-text details explaining the cancellation reason. Filter by booking price. Filter by iD of the original booking associated with this record. ### Range Filters Filter by the resource allocation value for this cancelled booking greater than or equal to this value. Filter by the resource allocation value for this cancelled booking less than or equal to this value. Filter by the resource no return policy value for this cancelled booking greater than or equal to this value. Filter by the resource no return policy value for this cancelled booking less than or equal to this value. Filter by the resource no return policy all resources value for this cancelled booking greater than or equal to this value. Filter by the resource no return policy all resources value for this cancelled booking less than or equal to this value. Filter by the resource no return policy all users value for this cancelled booking greater than or equal to this value. Filter by the resource no return policy all users value for this cancelled booking less than or equal to this value. Filter by iD of the resource resource type associated with this record greater than or equal to this value. Filter by iD of the resource resource type associated with this record less than or equal to this value. Filter by booking start time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking start time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking end time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking end time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last notification time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for last notification time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the repeat every value for this cancelled booking greater than or equal to this value. Filter by the repeat every value for this cancelled booking less than or equal to this value. Filter by date/time value for repeat until greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for repeat until less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the override price value for this cancelled booking greater than or equal to this value. Filter by the override price value for this cancelled booking less than or equal to this value. Filter by date/time value for invoice date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for invoice date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the booking number value for this cancelled booking greater than or equal to this value. Filter by the booking number value for this cancelled booking less than or equal to this value. Filter by iD of the kisi key associated with this record greater than or equal to this value. Filter by iD of the kisi key associated with this record less than or equal to this value. Filter by date/time value for from time local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for from time local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for to time local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for to time local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for invoice date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for invoice date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by iD of the coworker invoice associated with this record greater than or equal to this value. Filter by iD of the coworker invoice associated with this record less than or equal to this value. Filter by the coworker extra service price value for this cancelled booking greater than or equal to this value. Filter by the coworker extra service price value for this cancelled booking less than or equal to this value. Filter by the coworker extra service charge period value for this cancelled booking greater than or equal to this value. Filter by the coworker extra service charge period value for this cancelled booking less than or equal to this value. Filter by the coworker extra service total uses value for this cancelled booking greater than or equal to this value. Filter by the coworker extra service total uses value for this cancelled booking less than or equal to this value. Filter by date/time value for checked in at greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date/time value for checked in at less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by the max occupancy value for this cancelled booking greater than or equal to this value. Filter by the max occupancy value for this cancelled booking less than or equal to this value. Filter by the last minute price adjustment value for this cancelled booking greater than or equal to this value. Filter by the last minute price adjustment value for this cancelled booking less than or equal to this value. Filter by the dynamic price adjustment value for this cancelled booking greater than or equal to this value. Filter by the dynamic price adjustment value for this cancelled booking less than or equal to this value. Filter by the price factor last minute value for this cancelled booking greater than or equal to this value. Filter by the price factor last minute value for this cancelled booking less than or equal to this value. Filter by the price factor demand value for this cancelled booking greater than or equal to this value. Filter by the price factor demand value for this cancelled booking less than or equal to this value. Filter by date and time when the booking was cancelled greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time when the booking was cancelled less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking price greater than or equal to this value. Filter by booking price less than or equal to this value. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/cancelledbookings?page=1&size=15&orderBy=CreatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/cancelledbookings?' + new URLSearchParams({ page: 1, size: 15, orderBy: 'CreatedOn', dir: 1 // Ascending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/cancelledbookings', params={ 'page': 1, 'size': 15, 'orderBy': 'CreatedOn', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Filtering by CreatedOn ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/cancelledbookings?CancelledBooking_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/cancelledbookings?' + new URLSearchParams({ CancelledBooking_CreatedOn: 'example-value', orderBy: 'CreatedOn', dir: 1 }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/cancelledbookings', params={ 'CancelledBooking_CreatedOn': 'example-value', 'orderBy': 'CreatedOn', 'dir': 0 // Ascending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ### Range filters ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/cancelledbookings?from_CancelledBooking_UpdatedOn=2025-01-01T00:00&to_CancelledBooking_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} const response = await fetch( 'https://spaces.nexudus.com/api/spaces/cancelledbookings?' + new URLSearchParams({ from_CancelledBooking_UpdatedOn: '2025-01-01T00:00', to_CancelledBooking_UpdatedOn: '2025-12-31T23:59', orderBy: 'UpdatedOn', dir: 1 // Descending }), { headers: { 'Authorization': 'Bearer YOUR_TOKEN' } } ); const data = await response.json(); ``` ```python Python theme={null} import requests response = requests.get( 'https://spaces.nexudus.com/api/spaces/cancelledbookings', params={ 'from_CancelledBooking_UpdatedOn': '2025-01-01T00:00', 'to_CancelledBooking_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of CancelledBooking records matching the query. See the [Get one CancelledBooking](/rest-api/spaces/get-cancelledbookings-by-id) 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](/rest-api/spaces/get-cancelledbookings-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "Records": [ { "ResourceId": 0, "ResourceName": null, "ResourceAllocation": null, "ResourceHideInCalendar": null, "ResourceNoReturnPolicy": null, "ResourceNoReturnPolicyAllResources": null, "ResourceNoReturnPolicyAllUsers": null, "ResourceResourceTypeId": null, "ResourceResourceTypeName": null, "FloorPlanDeskId": null, "FloorPlanDeskName": null, "CoworkerId": null, "CoworkerCoworkerType": null, "CoworkerFullName": null, "CoworkerBillingName": null, "CoworkerCompanyName": null, "CoworkerTeamNames": null, "ExtraServiceId": null, "ExtraServiceName": null, "FromTime": "2025-01-15T10:30:00Z", "ToTime": "2025-01-15T10:30:00Z", "Notes": null, "PurchaseOrder": null, "DiscountCode": null, "LastNotificationTime": null, "GoogleCalendarId": null, "GoogleEventId": null, "Office365EventId": null, "PublicGoogleEventId": null, "Tentative": false, "Online": false, "TeamsAtTheTimeOfBooking": null, "TariffAtTheTimeOfBooking": null, "RepeatSeriesUniqueId": null, "Reminded": false, "MrmReminded": false, "Invoiced": false, "BookingNumber": null, "KisiKeyId": null, "StartScheduledJobId": null, "EndScheduledJobId": null, "Billed": false, "FromTimeLocal": null, "ToTimeLocal": null, "InvoiceDateLocal": null, "CoworkerInvoiceId": null, "CoworkerInvoiceNumber": null, "CoworkerInvoicePaid": false, "CoworkerInvoiceDraft": false, "CoworkerInvoiceVoid": false, "CoworkerInvoiceCreditNote": false, "CoworkerExtraServiceIds": null, "CoworkerExtraServicePrice": null, "CoworkerExtraServiceCurrencyCode": null, "CoworkerExtraServiceChargePeriod": null, "CoworkerExtraServiceTotalUses": null, "ZoomEventData": null, "CheckedInAt": null, "CancelIfNotPaid": false, "CancelIfNotCheckedIn": false, "MaxOccupancy": null, "LastMinutePriceAdjustment": null, "DynamicPriceAdjustment": null, "PriceFactorLastMinute": null, "PriceFactorDemand": null, "Office365AdminEventId": null, "CancellationReason": 0, "CancelledOn": "2025-01-15T10:30:00Z", "CancelledBy": null, "CancellationReasonDetails": null, "Price": null, "OriginalBookingId": null, "Id": 87654321, "UpdatedOn": "2025-01-15T10:30:00Z", "CreatedOn": "2025-01-10T08:00:00Z", "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "UpdatedBy": "admin@example.com", "IsNew": false, "SystemId": null, "ToStringText": "CancelledBooking Example", "LocalizationDetails": null, "CustomFields": null } ], "CurrentPageSize": 15, "CurrentPage": 1, "CurrentOrderField": "CreatedOn", "CurrentSortDirection": 1, "FirstItem": 1, "HasNextPage": false, "HasPreviousPage": false, "LastItem": 1, "PageNumber": 1, "PageSize": 15, "TotalItems": 1, "TotalPages": 1 } ```