> ## 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 Bookings > Search and list Booking records with filtering, sorting, and pagination. A booking is a reservation of a resource, such as a meeting room or desk, for a customer at a specified time; it can be tentative, recurring, charged, and invoiced. ## 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 **`Booking-List`** role. ## Enums | 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 being reserved; it determines the booking location and availability rules.. Filter by display value for Resource.Name.. Filter by display value for Resource.Allocation.. Filter by display value for Resource.HideInCalendar.. Filter by display value for Resource.NoReturnPolicy.. Filter by display value for Resource.NoReturnPolicyAllResources.. Filter by display value for Resource.NoReturnPolicyAllUsers.. Filter by display value for Resource.ResourceType.Id.. Filter by display value for Resource.ResourceType.Name.. Filter by optional ID of the floor-plan unit assigned within the selected resource. The unit must be connected to this resource. Filter by display value for FloorPlanDesk.Name.. Filter by optional ID of the customer this booking is for.. Filter by display value for Coworker.CoworkerType.. Filter by display value for Coworker.FullName.. Filter by display value for Coworker.MobilePhone.. Filter by display value for Coworker.LandLine.. Filter by display value for Coworker.BillingName.. Filter by display value for Coworker.CompanyName.. Filter by display value for Coworker.TeamNames.. Filter by optional ID of the rate used to price this booking. Set it only to a rate linked to the selected resource's ResourceType. When no rate is provided, the system calculates an applicable rate automatically.. Filter by display value for ExtraService.Name.. Filter by booking start date and time in UTC.. Filter by booking end date and time in UTC; it must be after FromTime.. Filter by customer-facing notes for the booking.. Filter by internal staff notes recorded when the booking is created.. Filter by whether to charge the booking immediately when it is created or updated.. Filter by whether to generate an invoice for the booking immediately.. Filter by whether the selected customer receives the booking charge. When false, the customer's team-paying member, if any, is the billing party.. Filter by whether to prevent available customer booking credit from being used for this booking.. Filter by optional customer purchase-order reference for the booking.. Filter by optional discount code applied when the booking price is calculated.. Filter by system-maintained UTC timestamp of the last booking notification.. Filter by internal Google Calendar identifier maintained by calendar synchronization.. Filter by internal Google Calendar event identifier maintained by calendar synchronization.. Filter by internal Microsoft 365 calendar event identifier maintained by synchronization.. Filter by internal public Google Calendar event identifier maintained by synchronization.. Filter by whether the booking is tentative and still requires confirmation. Customer bookings for resources requiring confirmation are created as tentative; administrators can create tentative bookings for any resource.. Filter by whether this is an online booking, as determined by the selected resource.. Filter by system snapshot of the customer's team memberships when the booking was made.. Filter by system snapshot of the customer's plan when the booking was made.. Filter by system-generated identifier linking all bookings in the same recurrence series; use it to find and update all bookings in that series.. Filter by whether to create a recurring series from this booking.. Filter by recurrence cycle: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth.. Filter by for a recurring booking update, selects whether to update this booking, future bookings, all bookings, not-charged bookings, or perform the corresponding delete or charge-reversal action.. Filter by optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks.. Filter by optional final UTC date and time for creating occurrences in the recurrence series.. Filter by whether a weekly recurring booking includes Mondays.. Filter by whether a weekly recurring booking includes Tuesdays.. Filter by whether a weekly recurring booking includes Wednesdays.. Filter by whether a weekly recurring booking includes Thursdays.. Filter by whether a weekly recurring booking includes Fridays.. Filter by whether a weekly recurring booking includes Saturdays.. Filter by whether a weekly recurring booking includes Sundays.. Filter by system flag showing whether the standard booking reminder has been sent.. Filter by system flag showing whether the standard booking notification has been sent.. Filter by system flag showing whether an MRM reminder has been sent.. Filter by optional total price override for this booking, before normal rate calculation.. Filter by whether the booking price has been calculated and posted to the customer's account as a CoworkerExtraService and, when applicable, CoworkerProducts. This does not indicate whether the booking has been invoiced.. Filter by uTC date and time when the booking was charged.. Filter by system-generated booking reference number.. Filter by internal Kisi access-control key identifier for this booking.. Filter by internal scheduled-job identifier for the booking start.. Filter by internal scheduled-job identifier for the booking end.. Filter by internal billing-processing state for this booking.. Filter by system-maintained local-time representation of FromTime.. Filter by system-maintained local-time representation of ToTime.. Filter by system-maintained local-time representation of InvoiceDate.. Filter by system-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity.. Filter by system-maintained invoice number associated with this booking, populated when the booking is included in an invoice.. Filter by read-only indicator that the associated invoice has been paid, populated when the booking is included in an invoice.. Filter by read-only indicator that the associated invoice is still a draft, populated when the booking is included in an invoice.. Filter by read-only indicator that the associated invoice has been voided, populated when the booking is included in an invoice.. Filter by read-only indicator that the associated invoice is a credit note, populated when the booking is included in an invoice.. Filter by system-maintained serialized identifiers of customer rate entitlements used by this booking.. Filter by system-calculated price from the customer's applicable rate entitlement.. Filter by system-calculated currency code for the customer rate entitlement used by this booking.. Filter by system-calculated charge-period setting for the customer rate entitlement used by this booking.. Filter by system-calculated number of customer rate uses consumed or available for this booking.. Filter by whether to include a Zoom meeting invitation for this booking.. Filter by internal Zoom event payload maintained by the integration.. Filter by uTC date and time when the booking was checked in through the booking workflow\.. Filter by system-derived resource policy that cancels this booking when payment is not received.. Filter by system-derived resource policy that cancels this booking when no check-in occurs.. Filter by maximum occupancy detected by sensors in the selected resource during this booking.. Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking.. Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location.. Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment.. Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing.. Filter by internal Microsoft 365 administrator calendar event identifier maintained by synchronization.. Filter by uTC date and time when the customer checked in for this booking.. Filter by uTC date and time when the customer checked out from this booking.. ### Range Filters Filter by display value for Resource.Allocation. greater than or equal to this value. Filter by display value for Resource.Allocation. less than or equal to this value. Filter by display value for Resource.NoReturnPolicy. greater than or equal to this value. Filter by display value for Resource.NoReturnPolicy. less than or equal to this value. Filter by display value for Resource.NoReturnPolicyAllResources. greater than or equal to this value. Filter by display value for Resource.NoReturnPolicyAllResources. less than or equal to this value. Filter by display value for Resource.NoReturnPolicyAllUsers. greater than or equal to this value. Filter by display value for Resource.NoReturnPolicyAllUsers. less than or equal to this value. Filter by display value for Resource.ResourceType.Id. greater than or equal to this value. Filter by display value for Resource.ResourceType.Id. less than or equal to this value. Filter by booking start date and time in UTC. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking start date and time in UTC. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking end date and time in UTC; it must be after FromTime. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by booking end date and time in UTC; it must be after FromTime. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained UTC timestamp of the last booking notification. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained UTC timestamp of the last booking notification. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks. greater than or equal to this value. Filter by optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks. less than or equal to this value. Filter by optional final UTC date and time for creating occurrences in the recurrence series. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by optional final UTC date and time for creating occurrences in the recurrence series. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by optional total price override for this booking, before normal rate calculation. greater than or equal to this value. Filter by optional total price override for this booking, before normal rate calculation. less than or equal to this value. Filter by uTC date and time when the booking was charged. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by uTC date and time when the booking was charged. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-generated booking reference number. greater than or equal to this value. Filter by system-generated booking reference number. less than or equal to this value. Filter by internal Kisi access-control key identifier for this booking. greater than or equal to this value. Filter by internal Kisi access-control key identifier for this booking. less than or equal to this value. Filter by system-maintained local-time representation of FromTime. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained local-time representation of FromTime. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained local-time representation of ToTime. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained local-time representation of ToTime. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained local-time representation of InvoiceDate. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained local-time representation of InvoiceDate. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by system-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity. greater than or equal to this value. Filter by system-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity. less than or equal to this value. Filter by system-calculated price from the customer's applicable rate entitlement. greater than or equal to this value. Filter by system-calculated price from the customer's applicable rate entitlement. less than or equal to this value. Filter by system-calculated charge-period setting for the customer rate entitlement used by this booking. greater than or equal to this value. Filter by system-calculated charge-period setting for the customer rate entitlement used by this booking. less than or equal to this value. Filter by system-calculated number of customer rate uses consumed or available for this booking. greater than or equal to this value. Filter by system-calculated number of customer rate uses consumed or available for this booking. less than or equal to this value. Filter by uTC date and time when the booking was checked in through the booking workflow. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by uTC date and time when the booking was checked in through the booking workflow. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by maximum occupancy detected by sensors in the selected resource during this booking. greater than or equal to this value. Filter by maximum occupancy detected by sensors in the selected resource during this booking. less than or equal to this value. Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking. greater than or equal to this value. Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking. less than or equal to this value. Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location. greater than or equal to this value. Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location. less than or equal to this value. Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment. greater than or equal to this value. Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment. less than or equal to this value. Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing. greater than or equal to this value. Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing. less than or equal to this value. Filter by uTC date and time when the customer checked in for this booking. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by uTC date and time when the customer checked in for this booking. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by uTC date and time when the customer checked out from this booking. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by uTC date and time when the customer checked out from this booking. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. 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/bookings?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/bookings?' + 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/bookings', 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/bookings?Booking_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/bookings?' + new URLSearchParams({ Booking_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/bookings', params={ 'Booking_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/bookings?from_Booking_UpdatedOn=2025-01-01T00:00&to_Booking_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/bookings?' + new URLSearchParams({ from_Booking_UpdatedOn: '2025-01-01T00:00', to_Booking_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/bookings', params={ 'from_Booking_UpdatedOn': '2025-01-01T00:00', 'to_Booking_UpdatedOn': '2025-12-31T23:59', 'orderBy': 'UpdatedOn', 'dir': 1 // Descending }, headers={ 'Authorization': 'Bearer YOUR_TOKEN' } ) data = response.json() ``` ## Response ### 200 The list of Booking records matching the query. See the [Get one Booking](/rest-api/spaces/get-bookings-by-id) endpoint for the full list of properties returned for each record. **Partial records** — The listing endpoint returns a summary representation of each Booking. 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`, `IncludeZoomInvite`. To get all fields, fetch the full record using the [Get one Booking](/rest-api/spaces/get-bookings-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, "CoworkerMobilePhone": null, "CoworkerLandLine": 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, "Notified": false, "MrmReminded": false, "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, "ZoomEventData": null, "CheckedInAt": null, "CancelIfNotPaid": false, "CancelIfNotCheckedIn": false, "MaxOccupancy": null, "LastMinutePriceAdjustment": null, "DynamicPriceAdjustment": null, "PriceFactorLastMinute": null, "PriceFactorDemand": null, "Office365AdminEventId": null, "CoworkerCheckedInAt": null, "CoworkerCheckedOutAt": 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": "Booking 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 } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.