> ## 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 for a specific `Resource` and, optionally, for a customer (`CoworkerId`) and a desk or unit in the floor plan (`FloorPlanDeskId`). **Charging vs Invoicing** — When a booking is charged (confusingly labelled `Invoiced` in the booking entity), a charge is posted to the customer account as a `CoworkerExtraService` with the calculated price. If the booking has no fixed rate (`ExtraServiceId = null`), Nexudus calculates the rate automatically based on the resource type, booking parameters and customer. A booking is actually invoiced when the `CoworkerExtraService` associated with it is invoiced. * `InvoiceThisCoworker = true` means the booking is charged to the customer making it rather than their paying member (if any). * `Tentative` bookings must be approved by an administrator before being confirmed or charged. They still block the calendar. * `Online` bookings are those made via the portal or the app. **Repeating bookings** — `RepeatBooking` and all repeat-configuration fields (`Repeats`, `RepeatEvery`, `RepeatUntil`, `RepeatOn*`) are create-only. Once a booking series is created, only `WhichBookingsToUpdate` can be used to update or delete bookings in the series. No new bookings can be added to an existing series. **Pricing overrides** — `OverridePrice` lets an admin set a fixed price for the booking, regardless of what extra service (rate) is associated with it. ## 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 Resource Id. Filter by resource name. Filter by resource allocation. Filter by resource hidden 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 type ID. Filter by 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 Mobile Phone. Filter by Coworker Land Line. 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 immediately. Filter by invoice immediately. Filter by charge the booking to the customer making it rather than their paying member (if any). 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 whether the booking was made in the portal or the app. Filter by teams at the time of booking. Filter by tariff at the time of booking. Filter by Repeat Series Unique Id. Filter by create a repeating booking series. Create-only: once created, only WhichBookingsToUpdate can be used to update the series. No new bookings can be added to the series. Filter by repeat cycle. Create-only. Filter by action to apply when updating or deleting bookings in a repeated series. This is the only field that can modify a series after creation. Filter by repeat every N periods. Create-only. Filter by repeat until date. Create-only. Filter by repeat on Mondays. Create-only. Filter by repeat on Tuesdays. Create-only. Filter by repeat on Wednesdays. Create-only. Filter by repeat on Thursdays. Create-only. Filter by repeat on Fridays. Create-only. Filter by repeat on Saturdays. Create-only. Filter by repeat on Sundays. Create-only. Filter by Reminded. Filter by Mrm Reminded. Filter by admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it. Filter by whether the booking has been charged. When true, a charge (CoworkerExtraService) has been posted to the customer account. Note: the booking is actually invoiced when the associated CoworkerExtraService is invoiced. 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 time. Filter by cancel if not paid. Filter by cancel if not checked in. Filter by maximum 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. ### 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 type ID greater than or equal to this value. Filter by 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 N periods. Create-only greater than or equal to this value. Filter by repeat every N periods. Create-only less than or equal to this value. Filter by repeat until date. Create-only greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by repeat until date. Create-only less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it greater than or equal to this value. Filter by admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it 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 time greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by checked in at time less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by maximum occupancy greater than or equal to this value. Filter by maximum 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 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, "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, "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 } ```