Get one Booking

GET

api

spaces

bookings

{id}

Get one Booking

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ResourceId": 123,
  "ResourceName": "<string>",
  "ResourceAllocation": 123,
  "ResourceHideInCalendar": true,
  "ResourceNoReturnPolicy": 123,
  "ResourceNoReturnPolicyAllResources": 123,
  "ResourceNoReturnPolicyAllUsers": 123,
  "ResourceResourceTypeId": 123,
  "ResourceResourceTypeName": "<string>",
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerMobilePhone": "<string>",
  "CoworkerLandLine": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "FromTime": "<string>",
  "ToTime": "<string>",
  "Notes": "<string>",
  "InternalNotes": "<string>",
  "ChargeNow": true,
  "InvoiceNow": true,
  "InvoiceThisCoworker": true,
  "DoNotUseBookingCredit": true,
  "PurchaseOrder": "<string>",
  "DiscountCode": "<string>",
  "LastNotificationTime": "<string>",
  "GoogleCalendarId": "<string>",
  "GoogleEventId": "<string>",
  "Office365EventId": "<string>",
  "PublicGoogleEventId": "<string>",
  "Tentative": true,
  "Online": true,
  "TeamsAtTheTimeOfBooking": "<string>",
  "TariffAtTheTimeOfBooking": "<string>",
  "RepeatSeriesUniqueId": "<string>",
  "RepeatBooking": true,
  "Repeats": 123,
  "WhichBookingsToUpdate": 123,
  "RepeatEvery": 123,
  "RepeatUntil": "<string>",
  "RepeatOnMondays": true,
  "RepeatOnTuesdays": true,
  "RepeatOnWednesdays": true,
  "RepeatOnThursdays": true,
  "RepeatOnFridays": true,
  "RepeatOnSaturdays": true,
  "RepeatOnSundays": true,
  "Reminded": true,
  "MrmReminded": true,
  "OverridePrice": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "BookingNumber": 123,
  "KisiKeyId": 123,
  "StartScheduledJobId": "<string>",
  "EndScheduledJobId": "<string>",
  "Billed": true,
  "FromTimeLocal": "<string>",
  "ToTimeLocal": "<string>",
  "InvoiceDateLocal": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "CoworkerInvoiceDraft": true,
  "CoworkerInvoiceVoid": true,
  "CoworkerInvoiceCreditNote": true,
  "CoworkerExtraServiceIds": "<string>",
  "CoworkerExtraServicePrice": 123,
  "CoworkerExtraServiceCurrencyCode": "<string>",
  "CoworkerExtraServiceChargePeriod": 123,
  "CoworkerExtraServiceTotalUses": 123,
  "IncludeZoomInvite": true,
  "ZoomEventData": "<string>",
  "CheckedInAt": "<string>",
  "CancelIfNotPaid": true,
  "CancelIfNotCheckedIn": true,
  "MaxOccupancy": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "Office365AdminEventId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the Booking record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/bookings/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/bookings/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/bookings/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the resource linked to this record.

string

Resource name.

integer

Resource allocation.

boolean

Resource hidden in calendar.

integer

The resource no return policy value for this booking.

integer

The resource no return policy all resources value for this booking.

integer

The resource no return policy all users value for this booking.

integer

Resource type ID.

string

Resource type name.

integer

ID of the floor plan desk linked to this record.

string

Floor plan desk name.

integer

ID of the coworker linked to this record.

string

The coworker coworker type value for this booking.

string

Coworker full name.

string

The coworker mobile phone value for this booking.

string

The coworker land line value for this booking.

string

Coworker billing name.

string

Coworker company name.

string

Coworker team names.

integer

ID of the extra service linked to this record.

string

Extra service name.

string

Booking start time.

string

Booking end time.

string

Optional notes or comments about this booking.

string

Internal notes.

boolean

Charge immediately.

boolean

Invoice immediately.

boolean

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

boolean

Do not use booking credit.

string

Purchase order.

string

Discount code.

string

Date/time value for last notification time.

string

ID of the google calendar associated with this record.

string

ID of the google event associated with this record.

string

ID of the office365 event associated with this record.

string

ID of the public google event associated with this record.

boolean

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

boolean

Whether the booking was made in the portal or the app.

string

Teams at the time of booking.

string

Tariff at the time of booking.

string

ID of the repeat series unique associated with this record.

boolean

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

Repeat cycle. Create-only. See eBookingRepeatCycle enum values: 1 = Daily, 2 = Weekly, 3 = Monthly, 4 = Yearly, 5 = FirstOfMonth, 6 = SecondOfMonth, 7 = ThirdOfMonth, 8 = LastOfMonth, 9 = FourthOfMonth.

integer

Action to apply when updating or deleting bookings in a repeated series. This is the only field that can modify a series after creation. See eRepeatedBookingUpdateAction enum values: 1 = UpdateThisBookingOnly, 2 = UpdateFutureBookingsOnly, 3 = UpdateAllBookings, 4 = UpdateNotChargedBookings, 5 = DeleteAllBookings, 6 = DeleteBookingsAfterThis, 7 = DeleteNotChargedBookings, 8 = RevertAllCharges.

integer

Repeat every N periods. Create-only.

string

Repeat until date. Create-only.

boolean

Repeat on Mondays. Create-only.

boolean

Repeat on Tuesdays. Create-only.

boolean

Repeat on Wednesdays. Create-only.

boolean

Repeat on Thursdays. Create-only.

boolean

Repeat on Fridays. Create-only.

boolean

Repeat on Saturdays. Create-only.

boolean

Repeat on Sundays. Create-only.

boolean

Whether reminded is enabled.

boolean

Whether mrm reminded is enabled.

number

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

boolean

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

Invoice date.

integer

Booking number.

integer

ID of the kisi key associated with this record.

string

ID of the start scheduled job associated with this record.

string

ID of the end scheduled job associated with this record.

boolean

Whether billed is enabled.

string

Date/time value for from time local.

string

Date/time value for to time local.

string

Date/time value for invoice date local.

integer

Coworker invoice ID.

string

Coworker invoice number.

boolean

Coworker invoice paid.

boolean

Whether coworker invoice draft is enabled.

boolean

Whether coworker invoice void is enabled.

boolean

Whether coworker invoice credit note is enabled.

string

The coworker extra service ids value for this booking.

number

The coworker extra service price value for this booking.

string

The coworker extra service currency code value for this booking.

integer

The coworker extra service charge period value for this booking.

integer

The coworker extra service total uses value for this booking.

boolean

Include Zoom invite.

string

The zoom event data value for this booking.

string

Checked in at time.

boolean

Cancel if not paid.

boolean

Cancel if not checked in.

integer

Maximum occupancy.

number

The last minute price adjustment value for this booking.

number

The dynamic price adjustment value for this booking.

number

The price factor last minute value for this booking.

number

The price factor demand value for this booking.

string

ID of the office365 admin event associated with this record.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get multiple BookingsRetrieve multiple Booking records by their Ids in a single request.

Get one Booking

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ResourceId": 123,
  "ResourceName": "<string>",
  "ResourceAllocation": 123,
  "ResourceHideInCalendar": true,
  "ResourceNoReturnPolicy": 123,
  "ResourceNoReturnPolicyAllResources": 123,
  "ResourceNoReturnPolicyAllUsers": 123,
  "ResourceResourceTypeId": 123,
  "ResourceResourceTypeName": "<string>",
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerMobilePhone": "<string>",
  "CoworkerLandLine": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "FromTime": "<string>",
  "ToTime": "<string>",
  "Notes": "<string>",
  "InternalNotes": "<string>",
  "ChargeNow": true,
  "InvoiceNow": true,
  "InvoiceThisCoworker": true,
  "DoNotUseBookingCredit": true,
  "PurchaseOrder": "<string>",
  "DiscountCode": "<string>",
  "LastNotificationTime": "<string>",
  "GoogleCalendarId": "<string>",
  "GoogleEventId": "<string>",
  "Office365EventId": "<string>",
  "PublicGoogleEventId": "<string>",
  "Tentative": true,
  "Online": true,
  "TeamsAtTheTimeOfBooking": "<string>",
  "TariffAtTheTimeOfBooking": "<string>",
  "RepeatSeriesUniqueId": "<string>",
  "RepeatBooking": true,
  "Repeats": 123,
  "WhichBookingsToUpdate": 123,
  "RepeatEvery": 123,
  "RepeatUntil": "<string>",
  "RepeatOnMondays": true,
  "RepeatOnTuesdays": true,
  "RepeatOnWednesdays": true,
  "RepeatOnThursdays": true,
  "RepeatOnFridays": true,
  "RepeatOnSaturdays": true,
  "RepeatOnSundays": true,
  "Reminded": true,
  "MrmReminded": true,
  "OverridePrice": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "BookingNumber": 123,
  "KisiKeyId": 123,
  "StartScheduledJobId": "<string>",
  "EndScheduledJobId": "<string>",
  "Billed": true,
  "FromTimeLocal": "<string>",
  "ToTimeLocal": "<string>",
  "InvoiceDateLocal": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "CoworkerInvoiceDraft": true,
  "CoworkerInvoiceVoid": true,
  "CoworkerInvoiceCreditNote": true,
  "CoworkerExtraServiceIds": "<string>",
  "CoworkerExtraServicePrice": 123,
  "CoworkerExtraServiceCurrencyCode": "<string>",
  "CoworkerExtraServiceChargePeriod": 123,
  "CoworkerExtraServiceTotalUses": 123,
  "IncludeZoomInvite": true,
  "ZoomEventData": "<string>",
  "CheckedInAt": "<string>",
  "CancelIfNotPaid": true,
  "CancelIfNotCheckedIn": true,
  "MaxOccupancy": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "Office365AdminEventId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200