Skip to main content
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>'
{
  "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 bookingsRepeatBooking 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 overridesOverridePrice 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

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

Response

200

ResourceId
integer
ID of the resource linked to this record.
ResourceName
string
Resource name.
ResourceAllocation
integer
Resource allocation.
ResourceHideInCalendar
boolean
Resource hidden in calendar.
ResourceNoReturnPolicy
integer
The resource no return policy value for this booking.
ResourceNoReturnPolicyAllResources
integer
The resource no return policy all resources value for this booking.
ResourceNoReturnPolicyAllUsers
integer
The resource no return policy all users value for this booking.
ResourceResourceTypeId
integer
Resource type ID.
ResourceResourceTypeName
string
Resource type name.
FloorPlanDeskId
integer
ID of the floor plan desk linked to this record.
FloorPlanDeskName
string
Floor plan desk name.
CoworkerId
integer
ID of the coworker linked to this record.
CoworkerCoworkerType
string
The coworker coworker type value for this booking.
CoworkerFullName
string
Coworker full name.
CoworkerMobilePhone
string
The coworker mobile phone value for this booking.
CoworkerLandLine
string
The coworker land line value for this booking.
CoworkerBillingName
string
Coworker billing name.
CoworkerCompanyName
string
Coworker company name.
CoworkerTeamNames
string
Coworker team names.
ExtraServiceId
integer
ID of the extra service linked to this record.
ExtraServiceName
string
Extra service name.
FromTime
string
Booking start time.
ToTime
string
Booking end time.
Notes
string
Optional notes or comments about this booking.
InternalNotes
string
Internal notes.
ChargeNow
boolean
Charge immediately.
InvoiceNow
boolean
Invoice immediately.
InvoiceThisCoworker
boolean
Charge the booking to the customer making it rather than their paying member (if any).
DoNotUseBookingCredit
boolean
Do not use booking credit.
PurchaseOrder
string
Purchase order.
DiscountCode
string
Discount code.
LastNotificationTime
string
Date/time value for last notification time.
GoogleCalendarId
string
ID of the google calendar associated with this record.
GoogleEventId
string
ID of the google event associated with this record.
Office365EventId
string
ID of the office365 event associated with this record.
PublicGoogleEventId
string
ID of the public google event associated with this record.
Tentative
boolean
Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
Online
boolean
Whether the booking was made in the portal or the app.
TeamsAtTheTimeOfBooking
string
Teams at the time of booking.
TariffAtTheTimeOfBooking
string
Tariff at the time of booking.
RepeatSeriesUniqueId
string
ID of the repeat series unique associated with this record.
RepeatBooking
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.
Repeats
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.
WhichBookingsToUpdate
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.
RepeatEvery
integer
Repeat every N periods. Create-only.
RepeatUntil
string
Repeat until date. Create-only.
RepeatOnMondays
boolean
Repeat on Mondays. Create-only.
RepeatOnTuesdays
boolean
Repeat on Tuesdays. Create-only.
RepeatOnWednesdays
boolean
Repeat on Wednesdays. Create-only.
RepeatOnThursdays
boolean
Repeat on Thursdays. Create-only.
RepeatOnFridays
boolean
Repeat on Fridays. Create-only.
RepeatOnSaturdays
boolean
Repeat on Saturdays. Create-only.
RepeatOnSundays
boolean
Repeat on Sundays. Create-only.
Reminded
boolean
Whether reminded is enabled.
MrmReminded
boolean
Whether mrm reminded is enabled.
OverridePrice
number
Admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it.
Invoiced
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.
InvoiceDate
string
Invoice date.
BookingNumber
integer
Booking number.
KisiKeyId
integer
ID of the kisi key associated with this record.
StartScheduledJobId
string
ID of the start scheduled job associated with this record.
EndScheduledJobId
string
ID of the end scheduled job associated with this record.
Billed
boolean
Whether billed is enabled.
FromTimeLocal
string
Date/time value for from time local.
ToTimeLocal
string
Date/time value for to time local.
InvoiceDateLocal
string
Date/time value for invoice date local.
CoworkerInvoiceId
integer
Coworker invoice ID.
CoworkerInvoiceNumber
string
Coworker invoice number.
CoworkerInvoicePaid
boolean
Coworker invoice paid.
CoworkerInvoiceDraft
boolean
Whether coworker invoice draft is enabled.
CoworkerInvoiceVoid
boolean
Whether coworker invoice void is enabled.
CoworkerInvoiceCreditNote
boolean
Whether coworker invoice credit note is enabled.
CoworkerExtraServiceIds
string
The coworker extra service ids value for this booking.
CoworkerExtraServicePrice
number
The coworker extra service price value for this booking.
CoworkerExtraServiceCurrencyCode
string
The coworker extra service currency code value for this booking.
CoworkerExtraServiceChargePeriod
integer
The coworker extra service charge period value for this booking.
CoworkerExtraServiceTotalUses
integer
The coworker extra service total uses value for this booking.
IncludeZoomInvite
boolean
Include Zoom invite.
ZoomEventData
string
The zoom event data value for this booking.
CheckedInAt
string
Checked in at time.
CancelIfNotPaid
boolean
Cancel if not paid.
CancelIfNotCheckedIn
boolean
Cancel if not checked in.
MaxOccupancy
integer
Maximum occupancy.
LastMinutePriceAdjustment
number
The last minute price adjustment value for this booking.
DynamicPriceAdjustment
number
The dynamic price adjustment value for this booking.
PriceFactorLastMinute
number
The price factor last minute value for this booking.
PriceFactorDemand
number
The price factor demand value for this booking.
Office365AdminEventId
string
ID of the office365 admin event associated with this record.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
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
}