Get one Booking

Retrieve a single Booking record by its Id.

GET /api/spaces/bookings/{id}

Get one Booking

cURL

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

200

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

id · integer · required

The Id of the Booking record to retrieve.

Code Examples

cURL

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

Response

200

ResourceId · integer

Resource Id.

ResourceName · string

Resource name.

ResourceAllocation · integer

Resource allocation.

ResourceHideInCalendar · boolean

Resource hidden in calendar.

ResourceNoReturnPolicy · integer

Resource No Return Policy.

ResourceNoReturnPolicyAllResources · integer

Resource No Return Policy All Resources.

ResourceNoReturnPolicyAllUsers · integer

Resource No Return Policy All Users.

ResourceResourceTypeId · integer

Resource type ID.

ResourceResourceTypeName · string

Resource type name.

FloorPlanDeskId · integer

Floor Plan Desk Id.

FloorPlanDeskName · string

Floor plan desk name.

CoworkerId · integer

Coworker Id.

CoworkerCoworkerType · string

Coworker Coworker Type.

CoworkerFullName · string

Coworker full name.

CoworkerMobilePhone · string

Coworker Mobile Phone.

CoworkerLandLine · string

Coworker Land Line.

CoworkerBillingName · string

Coworker billing name.

CoworkerCompanyName · string

Coworker company name.

CoworkerTeamNames · string

Coworker team names.

ExtraServiceId · integer

Extra Service Id.

ExtraServiceName · string

Extra service name.

FromTime · string

Booking start time.

ToTime · string

Booking end time.

Notes · string

Notes.

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

Last Notification Time.

GoogleCalendarId · string

Google Calendar Id.

GoogleEventId · string

Google Event Id.

Office365EventId · string

Office365Event Id.

PublicGoogleEventId · string

Public Google Event Id.

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

Repeat Series Unique Id.

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

Reminded.

MrmReminded · boolean

Mrm Reminded.

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

Kisi Key Id.

StartScheduledJobId · string

Start Scheduled Job Id.

EndScheduledJobId · string

End Scheduled Job Id.

Billed · boolean

Billed.

FromTimeLocal · string

From Time Local.

ToTimeLocal · string

To Time Local.

InvoiceDateLocal · string

Invoice Date Local.

CoworkerInvoiceId · integer

Coworker invoice ID.

CoworkerInvoiceNumber · string

Coworker invoice number.

CoworkerInvoicePaid · boolean

Coworker invoice paid.

CoworkerInvoiceDraft · boolean

Coworker Invoice Draft.

CoworkerInvoiceVoid · boolean

Coworker Invoice Void.

CoworkerInvoiceCreditNote · boolean

Coworker Invoice Credit Note.

CoworkerExtraServiceIds · string

Coworker Extra Service Ids.

CoworkerExtraServicePrice · number

Coworker Extra Service Price.

CoworkerExtraServiceCurrencyCode · string

Coworker Extra Service Currency Code.

CoworkerExtraServiceChargePeriod · integer

Coworker Extra Service Charge Period.

CoworkerExtraServiceTotalUses · integer

Coworker Extra Service Total Uses.

IncludeZoomInvite · boolean

Include Zoom invite.

ZoomEventData · string

Zoom Event Data.

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

Last Minute Price Adjustment.

DynamicPriceAdjustment · number

Dynamic Price Adjustment.

PriceFactorLastMinute · number

Price Factor Last Minute.

PriceFactorDemand · number

Price Factor Demand.

Office365AdminEventId · string

Office365Admin Event Id.

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": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Booking Example",
  "LocalizationDetails": null,
  "CustomFields": null
}