Search Bookings

GET

api

spaces

bookings

Search Bookings

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

import requests

url = "https://spaces.nexudus.com/api/spaces/bookings"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/bookings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the resource linked to this record.

string

Filter by resource name.

integer

Filter by resource allocation.

boolean

Filter by resource hidden in calendar.

integer

Filter by the resource no return policy value for this booking.

integer

Filter by the resource no return policy all resources value for this booking.

integer

Filter by the resource no return policy all users value for this booking.

integer

Filter by resource type ID.

string

Filter by resource type name.

integer

Filter by iD of the floor plan desk linked to this record.

string

Filter by floor plan desk name.

integer

Filter by iD of the coworker linked to this record.

string

Filter by the coworker coworker type value for this booking.

string

Filter by coworker full name.

string

Filter by the coworker mobile phone value for this booking.

string

Filter by the coworker land line value for this booking.

string

Filter by coworker billing name.

string

Filter by coworker company name.

string

Filter by coworker team names.

integer

Filter by iD of the extra service linked to this record.

string

Filter by extra service name.

string

Filter by booking start time.

string

Filter by booking end time.

string

Filter by optional notes or comments about this booking.

string

Filter by internal notes.

boolean

Filter by charge immediately.

boolean

Filter by invoice immediately.

boolean

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

boolean

Filter by do not use booking credit.

string

Filter by purchase order.

string

Filter by discount code.

string

Filter by date/time value for last notification time.

string

Filter by iD of the google calendar associated with this record.

string

Filter by iD of the google event associated with this record.

string

Filter by iD of the office365 event associated with this record.

string

Filter by iD of the public google event associated with this record.

boolean

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

boolean

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

string

Filter by teams at the time of booking.

string

Filter by tariff at the time of booking.

string

Filter by iD of the repeat series unique associated with this record.

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.

integer

Filter by repeat cycle. Create-only.

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.

integer

Filter by repeat every N periods. Create-only.

string

Filter by repeat until date. Create-only.

boolean

Filter by repeat on Mondays. Create-only.

boolean

Filter by repeat on Tuesdays. Create-only.

boolean

Filter by repeat on Wednesdays. Create-only.

boolean

Filter by repeat on Thursdays. Create-only.

boolean

Filter by repeat on Fridays. Create-only.

boolean

Filter by repeat on Saturdays. Create-only.

boolean

Filter by repeat on Sundays. Create-only.

boolean

Filter by whether reminded is enabled.

boolean

Filter by whether mrm reminded is enabled.

number

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

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.

string

Filter by invoice date.

integer

Filter by booking number.

integer

Filter by iD of the kisi key associated with this record.

string

Filter by iD of the start scheduled job associated with this record.

string

Filter by iD of the end scheduled job associated with this record.

boolean

Filter by whether billed is enabled.

string

Filter by date/time value for from time local.

string

Filter by date/time value for to time local.

string

Filter by date/time value for invoice date local.

integer

Filter by coworker invoice ID.

string

Filter by coworker invoice number.

boolean

Filter by coworker invoice paid.

boolean

Filter by whether coworker invoice draft is enabled.

boolean

Filter by whether coworker invoice void is enabled.

boolean

Filter by whether coworker invoice credit note is enabled.

string

Filter by the coworker extra service ids value for this booking.

number

Filter by the coworker extra service price value for this booking.

string

Filter by the coworker extra service currency code value for this booking.

integer

Filter by the coworker extra service charge period value for this booking.

integer

Filter by the coworker extra service total uses value for this booking.

boolean

Filter by include Zoom invite.

string

Filter by the zoom event data value for this booking.

string

Filter by checked in at time.

boolean

Filter by cancel if not paid.

boolean

Filter by cancel if not checked in.

integer

Filter by maximum occupancy.

number

Filter by the last minute price adjustment value for this booking.

number

Filter by the dynamic price adjustment value for this booking.

number

Filter by the price factor last minute value for this booking.

number

Filter by the price factor demand value for this booking.

string

Filter by iD of the office365 admin event associated with this record.

Range Filters

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

string

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

string

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

string

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

string

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

string

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

string

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

integer

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

integer

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

string

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

string

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

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.

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.

string

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

string

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

integer

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

integer

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

integer

Filter by iD of the kisi key associated with this record greater than or equal to this value.

integer

Filter by iD of the kisi key associated with this record less than or equal to this value.

string

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

string

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

string

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

string

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

string

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

string

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

integer

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

integer

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

number

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

number

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

integer

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

integer

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

integer

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

integer

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

string

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

string

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

integer

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

integer

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

number

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

string

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

string

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

string

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

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/bookings?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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();

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

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

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();

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

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"

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();

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

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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": "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
}

Get one BookingRetrieve a single Booking record by its Id.

Search Bookings

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

import requests

url = "https://spaces.nexudus.com/api/spaces/bookings"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/bookings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200