Skip to main content
GET
/
api
/
spaces
/
cancelledbookings
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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

ValueName
0Unknown
1NoLongerNeeded
2TooExpensive
3BadPreviousExperience
4RebookedForADifferentTime
5FailedToPayUpfront
6Integration
7Other
8NotCheckedIn
9MarketPlace

Query Parameters

Pagination & Sorting

page
integer
default:"1"
The page number to retrieve.
size
integer
default:"25"
The number of records per page.
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
dir
integer
Sort direction. 1 for ascending, -1 for descending.

Filters

CancelledBooking_Resource
integer
Filter by Resource Id.
CancelledBooking_Resource_Name
string
Filter by resource name.
CancelledBooking_Resource_Allocation
integer
Filter by Resource Allocation.
CancelledBooking_Resource_HideInCalendar
boolean
Filter by Resource Hide In Calendar.
CancelledBooking_Resource_NoReturnPolicy
integer
Filter by Resource No Return Policy.
CancelledBooking_Resource_NoReturnPolicyAllResources
integer
Filter by Resource No Return Policy All Resources.
CancelledBooking_Resource_NoReturnPolicyAllUsers
integer
Filter by Resource No Return Policy All Users.
CancelledBooking_Resource_ResourceType_Id
integer
Filter by Resource Resource Type Id.
CancelledBooking_Resource_ResourceType_Name
string
Filter by Resource Resource Type Name.
CancelledBooking_FloorPlanDesk
integer
Filter by Floor Plan Desk Id.
CancelledBooking_FloorPlanDesk_Name
string
Filter by Floor Plan Desk Name.
CancelledBooking_Coworker
integer
Filter by Coworker Id.
CancelledBooking_Coworker_CoworkerType
string
Filter by Coworker Coworker Type.
CancelledBooking_Coworker_FullName
string
Filter by coworker full name.
CancelledBooking_Coworker_BillingName
string
Filter by coworker billing name.
CancelledBooking_Coworker_CompanyName
string
Filter by coworker company name.
CancelledBooking_Coworker_TeamNames
string
Filter by Coworker Team Names.
CancelledBooking_ExtraService
integer
Filter by Extra Service Id.
CancelledBooking_ExtraService_Name
string
Filter by extra service name.
CancelledBooking_FromTime
string
Filter by booking start time.
CancelledBooking_ToTime
string
Filter by booking end time.
CancelledBooking_Notes
string
Filter by notes.
CancelledBooking_InternalNotes
string
Filter by Internal Notes.
CancelledBooking_ChargeNow
boolean
Filter by Charge Now.
CancelledBooking_InvoiceNow
boolean
Filter by Invoice Now.
CancelledBooking_InvoiceThisCoworker
boolean
Filter by Invoice This Coworker.
CancelledBooking_DoNotUseBookingCredit
boolean
Filter by Do Not Use Booking Credit.
CancelledBooking_PurchaseOrder
string
Filter by Purchase Order.
CancelledBooking_DiscountCode
string
Filter by Discount Code.
CancelledBooking_LastNotificationTime
string
Filter by Last Notification Time.
CancelledBooking_GoogleCalendarId
string
Filter by Google Calendar Id.
CancelledBooking_GoogleEventId
string
Filter by Google Event Id.
CancelledBooking_Office365EventId
string
Filter by Office365Event Id.
CancelledBooking_PublicGoogleEventId
string
Filter by Public Google Event Id.
CancelledBooking_Tentative
boolean
Filter by tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
CancelledBooking_Online
boolean
Filter by Online.
CancelledBooking_TeamsAtTheTimeOfBooking
string
Filter by Teams At The Time Of Booking.
CancelledBooking_TariffAtTheTimeOfBooking
string
Filter by Tariff At The Time Of Booking.
CancelledBooking_RepeatSeriesUniqueId
string
Filter by Repeat Series Unique Id.
CancelledBooking_RepeatBooking
boolean
Filter by Repeat Booking.
CancelledBooking_Repeats
integer
Filter by Repeats.
CancelledBooking_WhichBookingsToUpdate
integer
Filter by Which Bookings To Update.
CancelledBooking_RepeatEvery
integer
Filter by Repeat Every.
CancelledBooking_RepeatUntil
string
Filter by Repeat Until.
CancelledBooking_RepeatOnMondays
boolean
Filter by Repeat On Mondays.
CancelledBooking_RepeatOnTuesdays
boolean
Filter by Repeat On Tuesdays.
CancelledBooking_RepeatOnWednesdays
boolean
Filter by Repeat On Wednesdays.
CancelledBooking_RepeatOnThursdays
boolean
Filter by Repeat On Thursdays.
CancelledBooking_RepeatOnFridays
boolean
Filter by Repeat On Fridays.
CancelledBooking_RepeatOnSaturdays
boolean
Filter by Repeat On Saturdays.
CancelledBooking_RepeatOnSundays
boolean
Filter by Repeat On Sundays.
CancelledBooking_Reminded
boolean
Filter by Reminded.
CancelledBooking_MrmReminded
boolean
Filter by Mrm Reminded.
CancelledBooking_OverridePrice
number
Filter by Override Price.
CancelledBooking_Invoiced
boolean
Filter by whether the booking had been charged. When true, a charge (CoworkerExtraService) had been posted to the customer account.
CancelledBooking_InvoiceDate
string
Filter by Invoice Date.
CancelledBooking_BookingNumber
integer
Filter by Booking Number.
CancelledBooking_KisiKeyId
integer
Filter by Kisi Key Id.
CancelledBooking_StartScheduledJobId
string
Filter by Start Scheduled Job Id.
CancelledBooking_EndScheduledJobId
string
Filter by End Scheduled Job Id.
CancelledBooking_Billed
boolean
Filter by Billed.
CancelledBooking_FromTimeLocal
string
Filter by From Time Local.
CancelledBooking_ToTimeLocal
string
Filter by To Time Local.
CancelledBooking_InvoiceDateLocal
string
Filter by Invoice Date Local.
CancelledBooking_CoworkerInvoiceId
integer
Filter by Coworker Invoice Id.
CancelledBooking_CoworkerInvoiceNumber
string
Filter by Coworker Invoice Number.
CancelledBooking_CoworkerInvoicePaid
boolean
Filter by Coworker Invoice Paid.
CancelledBooking_CoworkerInvoiceDraft
boolean
Filter by Coworker Invoice Draft.
CancelledBooking_CoworkerInvoiceVoid
boolean
Filter by Coworker Invoice Void.
CancelledBooking_CoworkerInvoiceCreditNote
boolean
Filter by Coworker Invoice Credit Note.
CancelledBooking_CoworkerExtraServiceIds
string
Filter by Coworker Extra Service Ids.
CancelledBooking_CoworkerExtraServicePrice
number
Filter by Coworker Extra Service Price.
CancelledBooking_CoworkerExtraServiceCurrencyCode
string
Filter by Coworker Extra Service Currency Code.
CancelledBooking_CoworkerExtraServiceChargePeriod
integer
Filter by Coworker Extra Service Charge Period.
CancelledBooking_CoworkerExtraServiceTotalUses
integer
Filter by Coworker Extra Service Total Uses.
CancelledBooking_IncludeZoomInvite
boolean
Filter by Include Zoom Invite.
CancelledBooking_ZoomEventData
string
Filter by Zoom Event Data.
CancelledBooking_CheckedInAt
string
Filter by Checked In At.
CancelledBooking_CancelIfNotPaid
boolean
Filter by Cancel If Not Paid.
CancelledBooking_CancelIfNotCheckedIn
boolean
Filter by Cancel If Not Checked In.
CancelledBooking_MaxOccupancy
integer
Filter by Max Occupancy.
CancelledBooking_LastMinutePriceAdjustment
number
Filter by Last Minute Price Adjustment.
CancelledBooking_DynamicPriceAdjustment
number
Filter by Dynamic Price Adjustment.
CancelledBooking_PriceFactorLastMinute
number
Filter by Price Factor Last Minute.
CancelledBooking_PriceFactorDemand
number
Filter by Price Factor Demand.
CancelledBooking_Office365AdminEventId
string
Filter by Office365Admin Event Id.
CancelledBooking_CancellationReason
integer
Filter by reason the booking was cancelled, e.g. NoLongerNeeded, TooExpensive, or NotCheckedIn.
CancelledBooking_CancelledOn
string
Filter by date and time when the booking was cancelled.
CancelledBooking_CancelledBy
string
Filter by name or identifier of the user who cancelled the booking.
CancelledBooking_CancellationReasonDetails
string
Filter by additional free-text details explaining the cancellation reason.
CancelledBooking_Price
number
Filter by booking price.
CancelledBooking_OriginalBookingId
string
Filter by Original Booking Id.

Range Filters

from_CancelledBooking_ResourceAllocation
integer
Filter by resource allocation greater than or equal to this value.
to_CancelledBooking_ResourceAllocation
integer
Filter by resource allocation less than or equal to this value.
from_CancelledBooking_ResourceNoReturnPolicy
integer
Filter by resource no return policy greater than or equal to this value.
to_CancelledBooking_ResourceNoReturnPolicy
integer
Filter by resource no return policy less than or equal to this value.
from_CancelledBooking_ResourceNoReturnPolicyAllResources
integer
Filter by resource no return policy all resources greater than or equal to this value.
to_CancelledBooking_ResourceNoReturnPolicyAllResources
integer
Filter by resource no return policy all resources less than or equal to this value.
from_CancelledBooking_ResourceNoReturnPolicyAllUsers
integer
Filter by resource no return policy all users greater than or equal to this value.
to_CancelledBooking_ResourceNoReturnPolicyAllUsers
integer
Filter by resource no return policy all users less than or equal to this value.
from_CancelledBooking_ResourceResourceTypeId
integer
Filter by resource resource type id greater than or equal to this value.
to_CancelledBooking_ResourceResourceTypeId
integer
Filter by resource resource type id less than or equal to this value.
from_CancelledBooking_FromTime
string
Filter by booking start time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_FromTime
string
Filter by booking start time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_ToTime
string
Filter by booking end time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_ToTime
string
Filter by booking end time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_LastNotificationTime
string
Filter by last notification time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_LastNotificationTime
string
Filter by last notification time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_RepeatEvery
integer
Filter by repeat every greater than or equal to this value.
to_CancelledBooking_RepeatEvery
integer
Filter by repeat every less than or equal to this value.
from_CancelledBooking_RepeatUntil
string
Filter by repeat until greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_RepeatUntil
string
Filter by repeat until less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_OverridePrice
number
Filter by override price greater than or equal to this value.
to_CancelledBooking_OverridePrice
number
Filter by override price less than or equal to this value.
from_CancelledBooking_InvoiceDate
string
Filter by invoice date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_InvoiceDate
string
Filter by invoice date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_BookingNumber
integer
Filter by booking number greater than or equal to this value.
to_CancelledBooking_BookingNumber
integer
Filter by booking number less than or equal to this value.
from_CancelledBooking_KisiKeyId
integer
Filter by kisi key id greater than or equal to this value.
to_CancelledBooking_KisiKeyId
integer
Filter by kisi key id less than or equal to this value.
from_CancelledBooking_FromTimeLocal
string
Filter by from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_FromTimeLocal
string
Filter by from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_ToTimeLocal
string
Filter by to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_ToTimeLocal
string
Filter by to time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_InvoiceDateLocal
string
Filter by invoice date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_InvoiceDateLocal
string
Filter by invoice date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_CoworkerInvoiceId
integer
Filter by coworker invoice id greater than or equal to this value.
to_CancelledBooking_CoworkerInvoiceId
integer
Filter by coworker invoice id less than or equal to this value.
from_CancelledBooking_CoworkerExtraServicePrice
number
Filter by coworker extra service price greater than or equal to this value.
to_CancelledBooking_CoworkerExtraServicePrice
number
Filter by coworker extra service price less than or equal to this value.
from_CancelledBooking_CoworkerExtraServiceChargePeriod
integer
Filter by coworker extra service charge period greater than or equal to this value.
to_CancelledBooking_CoworkerExtraServiceChargePeriod
integer
Filter by coworker extra service charge period less than or equal to this value.
from_CancelledBooking_CoworkerExtraServiceTotalUses
integer
Filter by coworker extra service total uses greater than or equal to this value.
to_CancelledBooking_CoworkerExtraServiceTotalUses
integer
Filter by coworker extra service total uses less than or equal to this value.
from_CancelledBooking_CheckedInAt
string
Filter by checked in at greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_CheckedInAt
string
Filter by checked in at less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_MaxOccupancy
integer
Filter by max occupancy greater than or equal to this value.
to_CancelledBooking_MaxOccupancy
integer
Filter by max occupancy less than or equal to this value.
from_CancelledBooking_LastMinutePriceAdjustment
number
Filter by last minute price adjustment greater than or equal to this value.
to_CancelledBooking_LastMinutePriceAdjustment
number
Filter by last minute price adjustment less than or equal to this value.
from_CancelledBooking_DynamicPriceAdjustment
number
Filter by dynamic price adjustment greater than or equal to this value.
to_CancelledBooking_DynamicPriceAdjustment
number
Filter by dynamic price adjustment less than or equal to this value.
from_CancelledBooking_PriceFactorLastMinute
number
Filter by price factor last minute greater than or equal to this value.
to_CancelledBooking_PriceFactorLastMinute
number
Filter by price factor last minute less than or equal to this value.
from_CancelledBooking_PriceFactorDemand
number
Filter by price factor demand greater than or equal to this value.
to_CancelledBooking_PriceFactorDemand
number
Filter by price factor demand less than or equal to this value.
from_CancelledBooking_CancelledOn
string
Filter by date and time when the booking was cancelled greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_CancelledOn
string
Filter by date and time when the booking was cancelled less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_Price
number
Filter by booking price greater than or equal to this value.
to_CancelledBooking_Price
number
Filter by booking price less than or equal to this value.
from_CancelledBooking_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
from_CancelledBooking_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
to_CancelledBooking_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/cancelledbookings?page=1&size=15&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/cancelledbookings?CancelledBooking_CreatedOn=example-value&orderBy=CreatedOn&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records
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 included 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.
CurrentPage
integer
Current page number.
CurrentPageSize
integer
Number of records per page.
CurrentOrderField
string
The field used for sorting.
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
FirstItem
integer
Index of the first item on the current page.
LastItem
integer
Index of the last item on the current page.
TotalItems
integer
Total number of matching records across all pages.
TotalPages
integer
Total number of pages.
HasNextPage
boolean
Whether there is a next page of results.
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "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,
      "InternalNotes": null,
      "ChargeNow": false,
      "InvoiceNow": false,
      "InvoiceThisCoworker": false,
      "DoNotUseBookingCredit": false,
      "PurchaseOrder": null,
      "DiscountCode": null,
      "LastNotificationTime": null,
      "GoogleCalendarId": null,
      "GoogleEventId": null,
      "Office365EventId": null,
      "PublicGoogleEventId": null,
      "Tentative": false,
      "Online": false,
      "TeamsAtTheTimeOfBooking": null,
      "TariffAtTheTimeOfBooking": null,
      "RepeatSeriesUniqueId": null,
      "RepeatBooking": false,
      "Repeats": 0,
      "WhichBookingsToUpdate": 0,
      "RepeatEvery": null,
      "RepeatUntil": null,
      "RepeatOnMondays": false,
      "RepeatOnTuesdays": false,
      "RepeatOnWednesdays": false,
      "RepeatOnThursdays": false,
      "RepeatOnFridays": false,
      "RepeatOnSaturdays": false,
      "RepeatOnSundays": false,
      "Reminded": false,
      "MrmReminded": false,
      "OverridePrice": null,
      "Invoiced": false,
      "InvoiceDate": null,
      "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,
      "IncludeZoomInvite": false,
      "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
}