Search Bookings

Search and list Booking records with filtering, sorting, and pagination.

GET /api/spaces/bookings

Search Bookings

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/bookings \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

eBookingRepeatCycle — Repeats values

Value	Name
1	Daily
2	Weekly
3	Monthly
4	Yearly
5	FirstOfMonth
6	SecondOfMonth
7	ThirdOfMonth
8	LastOfMonth
9	FourthOfMonth

eRepeatedBookingUpdateAction — WhichBookingsToUpdate values

Value	Name
1	UpdateThisBookingOnly
2	UpdateFutureBookingsOnly
3	UpdateAllBookings
4	UpdateNotChargedBookings
5	DeleteAllBookings
6	DeleteBookingsAfterThis
7	DeleteNotChargedBookings
8	RevertAllCharges

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. 0 for ascending, 1 for descending.

Filters

Booking_Resource · integer

Filter by Resource Id.

Booking_Resource_Name · string

Filter by resource name.

Booking_Resource_Allocation · integer

Filter by resource allocation.

Booking_Resource_HideInCalendar · boolean

Filter by resource hidden in calendar.

Booking_Resource_NoReturnPolicy · integer

Filter by Resource No Return Policy.

Booking_Resource_NoReturnPolicyAllResources · integer

Filter by Resource No Return Policy All Resources.

Booking_Resource_NoReturnPolicyAllUsers · integer

Filter by Resource No Return Policy All Users.

Booking_Resource_ResourceType_Id · integer

Filter by resource type ID.

Booking_Resource_ResourceType_Name · string

Filter by resource type name.

Booking_FloorPlanDesk · integer

Filter by Floor Plan Desk Id.

Booking_FloorPlanDesk_Name · string

Filter by floor plan desk name.

Booking_Coworker · integer

Filter by Coworker Id.

Booking_Coworker_CoworkerType · string

Filter by Coworker Coworker Type.

Booking_Coworker_FullName · string

Filter by coworker full name.

Booking_Coworker_MobilePhone · string

Filter by Coworker Mobile Phone.

Booking_Coworker_LandLine · string

Filter by Coworker Land Line.

Booking_Coworker_BillingName · string

Filter by coworker billing name.

Booking_Coworker_CompanyName · string

Filter by coworker company name.

Booking_Coworker_TeamNames · string

Filter by coworker team names.

Booking_ExtraService · integer

Filter by Extra Service Id.

Booking_ExtraService_Name · string

Filter by extra service name.

Booking_FromTime · string

Filter by booking start time.

Booking_ToTime · string

Filter by booking end time.

Booking_Notes · string

Filter by notes.

Booking_InternalNotes · string

Filter by internal notes.

Booking_ChargeNow · boolean

Filter by charge immediately.

Booking_InvoiceNow · boolean

Filter by invoice immediately.

Booking_InvoiceThisCoworker · boolean

Filter by charge the booking to the customer making it rather than their paying member (if any).

Booking_DoNotUseBookingCredit · boolean

Filter by do not use booking credit.

Booking_PurchaseOrder · string

Filter by purchase order.

Booking_DiscountCode · string

Filter by discount code.

Booking_LastNotificationTime · string

Filter by Last Notification Time.

Booking_GoogleCalendarId · string

Filter by Google Calendar Id.

Booking_GoogleEventId · string

Filter by Google Event Id.

Booking_Office365EventId · string

Filter by Office365Event Id.

Booking_PublicGoogleEventId · string

Filter by Public Google Event Id.

Booking_Tentative · boolean

Filter by tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.

Booking_Online · boolean

Filter by whether the booking was made in the portal or the app.

Booking_TeamsAtTheTimeOfBooking · string

Filter by teams at the time of booking.

Booking_TariffAtTheTimeOfBooking · string

Filter by tariff at the time of booking.

Booking_RepeatSeriesUniqueId · string

Filter by Repeat Series Unique Id.

Booking_RepeatBooking · boolean

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.

Booking_Repeats · integer

Filter by repeat cycle. Create-only.

Booking_WhichBookingsToUpdate · integer

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.

Booking_RepeatEvery · integer

Filter by repeat every N periods. Create-only.

Booking_RepeatUntil · string

Filter by repeat until date. Create-only.

Booking_RepeatOnMondays · boolean

Filter by repeat on Mondays. Create-only.

Booking_RepeatOnTuesdays · boolean

Filter by repeat on Tuesdays. Create-only.

Booking_RepeatOnWednesdays · boolean

Filter by repeat on Wednesdays. Create-only.

Booking_RepeatOnThursdays · boolean

Filter by repeat on Thursdays. Create-only.

Booking_RepeatOnFridays · boolean

Filter by repeat on Fridays. Create-only.

Booking_RepeatOnSaturdays · boolean

Filter by repeat on Saturdays. Create-only.

Booking_RepeatOnSundays · boolean

Filter by repeat on Sundays. Create-only.

Booking_Reminded · boolean

Filter by Reminded.

Booking_MrmReminded · boolean

Filter by Mrm Reminded.

Booking_OverridePrice · number

Filter by admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it.

Booking_Invoiced · boolean

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.

Booking_InvoiceDate · string

Filter by invoice date.

Booking_BookingNumber · integer

Filter by booking number.

Booking_KisiKeyId · integer

Filter by Kisi Key Id.

Booking_StartScheduledJobId · string

Filter by Start Scheduled Job Id.

Booking_EndScheduledJobId · string

Filter by End Scheduled Job Id.

Booking_Billed · boolean

Filter by Billed.

Booking_FromTimeLocal · string

Filter by From Time Local.

Booking_ToTimeLocal · string

Filter by To Time Local.

Booking_InvoiceDateLocal · string

Filter by Invoice Date Local.

Booking_CoworkerInvoiceId · integer

Filter by coworker invoice ID.

Booking_CoworkerInvoiceNumber · string

Filter by coworker invoice number.

Booking_CoworkerInvoicePaid · boolean

Filter by coworker invoice paid.

Booking_CoworkerInvoiceDraft · boolean

Filter by Coworker Invoice Draft.

Booking_CoworkerInvoiceVoid · boolean

Filter by Coworker Invoice Void.

Booking_CoworkerInvoiceCreditNote · boolean

Filter by Coworker Invoice Credit Note.

Booking_CoworkerExtraServiceIds · string

Filter by Coworker Extra Service Ids.

Booking_CoworkerExtraServicePrice · number

Filter by Coworker Extra Service Price.

Booking_CoworkerExtraServiceCurrencyCode · string

Filter by Coworker Extra Service Currency Code.

Booking_CoworkerExtraServiceChargePeriod · integer

Filter by Coworker Extra Service Charge Period.

Booking_CoworkerExtraServiceTotalUses · integer

Filter by Coworker Extra Service Total Uses.

Booking_IncludeZoomInvite · boolean

Filter by include Zoom invite.

Booking_ZoomEventData · string

Filter by Zoom Event Data.

Booking_CheckedInAt · string

Filter by checked in at time.

Booking_CancelIfNotPaid · boolean

Filter by cancel if not paid.

Booking_CancelIfNotCheckedIn · boolean

Filter by cancel if not checked in.

Booking_MaxOccupancy · integer

Filter by maximum occupancy.

Booking_LastMinutePriceAdjustment · number

Filter by Last Minute Price Adjustment.

Booking_DynamicPriceAdjustment · number

Filter by Dynamic Price Adjustment.

Booking_PriceFactorLastMinute · number

Filter by Price Factor Last Minute.

Booking_PriceFactorDemand · number

Filter by Price Factor Demand.

Booking_Office365AdminEventId · string

Filter by Office365Admin Event Id.

Range Filters

from_Booking_ResourceAllocation · integer

Filter by resource allocation greater than or equal to this value.

to_Booking_ResourceAllocation · integer

Filter by resource allocation less than or equal to this value.

from_Booking_ResourceNoReturnPolicy · integer

Filter by resource no return policy greater than or equal to this value.

to_Booking_ResourceNoReturnPolicy · integer

Filter by resource no return policy less than or equal to this value.

from_Booking_ResourceNoReturnPolicyAllResources · integer

Filter by resource no return policy all resources greater than or equal to this value.

to_Booking_ResourceNoReturnPolicyAllResources · integer

Filter by resource no return policy all resources less than or equal to this value.

from_Booking_ResourceNoReturnPolicyAllUsers · integer

Filter by resource no return policy all users greater than or equal to this value.

to_Booking_ResourceNoReturnPolicyAllUsers · integer

Filter by resource no return policy all users less than or equal to this value.

from_Booking_ResourceResourceTypeId · integer

Filter by resource type ID greater than or equal to this value.

to_Booking_ResourceResourceTypeId · integer

Filter by resource type ID less than or equal to this value.

from_Booking_FromTime · string

Filter by booking start time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_FromTime · string

Filter by booking start time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_ToTime · string

Filter by booking end time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_ToTime · string

Filter by booking end time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_LastNotificationTime · string

Filter by last notification time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_LastNotificationTime · string

Filter by last notification time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_RepeatEvery · integer

Filter by repeat every N periods. Create-only greater than or equal to this value.

to_Booking_RepeatEvery · integer

Filter by repeat every N periods. Create-only less than or equal to this value.

from_Booking_RepeatUntil · string

Filter by repeat until date. Create-only greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_RepeatUntil · string

Filter by repeat until date. Create-only less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_OverridePrice · number

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.

to_Booking_OverridePrice · number

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.

from_Booking_InvoiceDate · string

Filter by invoice date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_InvoiceDate · string

Filter by invoice date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_BookingNumber · integer

Filter by booking number greater than or equal to this value.

to_Booking_BookingNumber · integer

Filter by booking number less than or equal to this value.

from_Booking_KisiKeyId · integer

Filter by kisi key id greater than or equal to this value.

to_Booking_KisiKeyId · integer

Filter by kisi key id less than or equal to this value.

from_Booking_FromTimeLocal · string

Filter by from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_FromTimeLocal · string

Filter by from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_ToTimeLocal · string

Filter by to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_ToTimeLocal · string

Filter by to time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_InvoiceDateLocal · string

Filter by invoice date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_InvoiceDateLocal · string

Filter by invoice date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_CoworkerInvoiceId · integer

Filter by coworker invoice ID greater than or equal to this value.

to_Booking_CoworkerInvoiceId · integer

Filter by coworker invoice ID less than or equal to this value.

from_Booking_CoworkerExtraServicePrice · number

Filter by coworker extra service price greater than or equal to this value.

to_Booking_CoworkerExtraServicePrice · number

Filter by coworker extra service price less than or equal to this value.

from_Booking_CoworkerExtraServiceChargePeriod · integer

Filter by coworker extra service charge period greater than or equal to this value.

to_Booking_CoworkerExtraServiceChargePeriod · integer

Filter by coworker extra service charge period less than or equal to this value.

from_Booking_CoworkerExtraServiceTotalUses · integer

Filter by coworker extra service total uses greater than or equal to this value.

to_Booking_CoworkerExtraServiceTotalUses · integer

Filter by coworker extra service total uses less than or equal to this value.

from_Booking_CheckedInAt · string

Filter by checked in at time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Booking_CheckedInAt · string

Filter by checked in at time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Booking_MaxOccupancy · integer

Filter by maximum occupancy greater than or equal to this value.

to_Booking_MaxOccupancy · integer

Filter by maximum occupancy less than or equal to this value.

from_Booking_LastMinutePriceAdjustment · number

Filter by last minute price adjustment greater than or equal to this value.

to_Booking_LastMinutePriceAdjustment · number

Filter by last minute price adjustment less than or equal to this value.

from_Booking_DynamicPriceAdjustment · number

Filter by dynamic price adjustment greater than or equal to this value.

to_Booking_DynamicPriceAdjustment · number

Filter by dynamic price adjustment less than or equal to this value.

from_Booking_PriceFactorLastMinute · number

Filter by price factor last minute greater than or equal to this value.

to_Booking_PriceFactorLastMinute · number

Filter by price factor last minute less than or equal to this value.

from_Booking_PriceFactorDemand · number

Filter by price factor demand greater than or equal to this value.

to_Booking_PriceFactorDemand · number

Filter by price factor demand less than or equal to this value.

from_Booking_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Booking_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_Booking_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Booking_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

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

Filtering by CreatedOn

cURL

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

Range filters

cURL

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"

Response

200

Records · Booking[]

The list of Booking records matching the query. See the Get one Booking 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 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 (0 = 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,
      "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": "[e-mail]",
      "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
}