> ## 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 | ## 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 Resource Id. Filter by resource name. Filter by Resource Allocation. Filter by Resource Hide In Calendar. Filter by Resource No Return Policy. Filter by Resource No Return Policy All Resources. Filter by Resource No Return Policy All Users. Filter by Resource Resource Type Id. Filter by Resource Resource Type Name. Filter by Floor Plan Desk Id. Filter by Floor Plan Desk Name. Filter by Coworker Id. Filter by Coworker Coworker Type. Filter by coworker full name. Filter by coworker billing name. Filter by coworker company name. Filter by Coworker Team Names. Filter by Extra Service Id. Filter by extra service name. Filter by booking start time. Filter by booking end time. Filter by notes. Filter by Internal Notes. Filter by Charge Now. Filter by Invoice Now. Filter by Invoice This Coworker. Filter by Do Not Use Booking Credit. Filter by Purchase Order. Filter by Discount Code. Filter by Last Notification Time. Filter by Google Calendar Id. Filter by Google Event Id. Filter by Office365Event Id. Filter by Public Google Event Id. Filter by tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar. Filter by Online. Filter by Teams At The Time Of Booking. Filter by Tariff At The Time Of Booking. Filter by Repeat Series Unique Id. Filter by Repeat Booking. Filter by Repeats. Filter by Which Bookings To Update. Filter by Repeat Every. Filter by Repeat Until. Filter by Repeat On Mondays. Filter by Repeat On Tuesdays. Filter by Repeat On Wednesdays. Filter by Repeat On Thursdays. Filter by Repeat On Fridays. Filter by Repeat On Saturdays. Filter by Repeat On Sundays. Filter by Reminded. Filter by Mrm Reminded. Filter by Override Price. Filter by whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account. Filter by Invoice Date. Filter by Booking Number. Filter by Kisi Key Id. Filter by Start Scheduled Job Id. Filter by End Scheduled Job Id. Filter by Billed. Filter by From Time Local. Filter by To Time Local. Filter by Invoice Date Local. Filter by Coworker Invoice Id. Filter by Coworker Invoice Number. Filter by Coworker Invoice Paid. Filter by Coworker Invoice Draft. Filter by Coworker Invoice Void. Filter by Coworker Invoice Credit Note. Filter by Coworker Extra Service Ids. Filter by Coworker Extra Service Price. Filter by Coworker Extra Service Currency Code. Filter by Coworker Extra Service Charge Period. Filter by Coworker Extra Service Total Uses. Filter by Include Zoom Invite. Filter by Zoom Event Data. Filter by Checked In At. Filter by Cancel If Not Paid. Filter by Cancel If Not Checked In. Filter by Max Occupancy. Filter by Last Minute Price Adjustment. Filter by Dynamic Price Adjustment. Filter by Price Factor Last Minute. Filter by Price Factor Demand. Filter by Office365Admin Event Id. 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 Original Booking Id. ### Range Filters Filter by resource allocation greater than or equal to this value. Filter by resource allocation less than or equal to this value. Filter by resource no return policy greater than or equal to this value. Filter by resource no return policy less than or equal to this value. Filter by resource no return policy all resources greater than or equal to this value. Filter by resource no return policy all resources less than or equal to this value. Filter by resource no return policy all users greater than or equal to this value. Filter by resource no return policy all users less than or equal to this value. Filter by resource resource type id greater than or equal to this value. Filter by resource resource type id 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 last notification time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by last notification time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat every greater than or equal to this value. Filter by repeat every less than or equal to this value. Filter by repeat until greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat until less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by override price greater than or equal to this value. Filter by override price less than or equal to this value. Filter by invoice date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoice date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking number greater than or equal to this value. Filter by booking number less than or equal to this value. Filter by kisi key id greater than or equal to this value. Filter by kisi key id less than or equal to this value. Filter by from time local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by from time local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by to time local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by to time local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoice date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by invoice date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by coworker invoice id greater than or equal to this value. Filter by coworker invoice id less than or equal to this value. Filter by coworker extra service price greater than or equal to this value. Filter by coworker extra service price less than or equal to this value. Filter by coworker extra service charge period greater than or equal to this value. Filter by coworker extra service charge period less than or equal to this value. Filter by coworker extra service total uses greater than or equal to this value. Filter by coworker extra service total uses less than or equal to this value. Filter by checked in at greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by checked in at less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by max occupancy greater than or equal to this value. Filter by max occupancy less than or equal to this value. Filter by last minute price adjustment greater than or equal to this value. Filter by last minute price adjustment less than or equal to this value. Filter by dynamic price adjustment greater than or equal to this value. Filter by dynamic price adjustment less than or equal to this value. Filter by price factor last minute greater than or equal to this value. Filter by price factor last minute less than or equal to this value. Filter by price factor demand greater than or equal to this value. Filter by price factor demand 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 } ```