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>'

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,
  "Notified": 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>",
  "CoworkerCheckedInAt": "<string>",
  "CoworkerCheckedOutAt": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A booking is a reservation of a resource, such as a meeting room or desk, for a customer at a specified time; it can be tentative, recurring, charged, and invoiced.

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 being reserved; it determines the booking location and availability rules..

string

Display value for Resource.Name..

integer

Display value for Resource.Allocation..

boolean

Display value for Resource.HideInCalendar..

integer

Display value for Resource.NoReturnPolicy..

integer

Display value for Resource.NoReturnPolicyAllResources..

integer

Display value for Resource.NoReturnPolicyAllUsers..

integer

Display value for Resource.ResourceType.Id..

string

Display value for Resource.ResourceType.Name..

integer

Optional ID of the floor-plan unit assigned within the selected resource. The unit must be connected to this resource.

string

Display value for FloorPlanDesk.Name..

integer

Optional ID of the customer this booking is for..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.FullName..

string

Display value for Coworker.MobilePhone..

string

Display value for Coworker.LandLine..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.TeamNames..

integer

Optional ID of the rate used to price this booking. Set it only to a rate linked to the selected resource’s ResourceType. When no rate is provided, the system calculates an applicable rate automatically..

string

Display value for ExtraService.Name..

string

Booking start date and time in UTC..

string

Booking end date and time in UTC; it must be after FromTime..

string

Customer-facing notes for the booking..

string

Internal staff notes recorded when the booking is created..

boolean

Whether to charge the booking immediately when it is created or updated..

boolean

Whether to generate an invoice for the booking immediately..

boolean

Whether the selected customer receives the booking charge. When false, the customer’s team-paying member, if any, is the billing party..

boolean

Whether to prevent available customer booking credit from being used for this booking..

string

Optional customer purchase-order reference for the booking..

string

Optional discount code applied when the booking price is calculated..

string

System-maintained UTC timestamp of the last booking notification..

string

Internal Google Calendar identifier maintained by calendar synchronization..

string

Internal Google Calendar event identifier maintained by calendar synchronization..

string

Internal Microsoft 365 calendar event identifier maintained by synchronization..

string

Internal public Google Calendar event identifier maintained by synchronization..

boolean

Whether the booking is tentative and still requires confirmation. Customer bookings for resources requiring confirmation are created as tentative; administrators can create tentative bookings for any resource..

boolean

Whether this is an online booking, as determined by the selected resource..

string

System snapshot of the customer’s team memberships when the booking was made..

string

System snapshot of the customer’s plan when the booking was made..

string

System-generated identifier linking all bookings in the same recurrence series; use it to find and update all bookings in that series..

boolean

Whether to create a recurring series from this booking..

integer

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

integer

For a recurring booking update, selects whether to update this booking, future bookings, all bookings, not-charged bookings, or perform the corresponding delete or charge-reversal action.. See eRepeatedBookingUpdateAction enum values: 1 = UpdateThisBookingOnly, 2 = UpdateFutureBookingsOnly, 3 = UpdateAllBookings, 4 = UpdateNotChargedBookings, 5 = DeleteAllBookings, 6 = DeleteBookingsAfterThis, 7 = DeleteNotChargedBookings, 8 = RevertAllCharges.

integer

Optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks..

string

Optional final UTC date and time for creating occurrences in the recurrence series..

boolean

Whether a weekly recurring booking includes Mondays..

boolean

Whether a weekly recurring booking includes Tuesdays..

boolean

Whether a weekly recurring booking includes Wednesdays..

boolean

Whether a weekly recurring booking includes Thursdays..

boolean

Whether a weekly recurring booking includes Fridays..

boolean

Whether a weekly recurring booking includes Saturdays..

boolean

Whether a weekly recurring booking includes Sundays..

boolean

System flag showing whether the standard booking reminder has been sent..

boolean

System flag showing whether the standard booking notification has been sent..

boolean

System flag showing whether an MRM reminder has been sent..

number

Optional total price override for this booking, before normal rate calculation..

boolean

Whether the booking price has been calculated and posted to the customer’s account as a CoworkerExtraService and, when applicable, CoworkerProducts. This does not indicate whether the booking has been invoiced..

string

UTC date and time when the booking was charged..

integer

System-generated booking reference number..

integer

Internal Kisi access-control key identifier for this booking..

string

Internal scheduled-job identifier for the booking start..

string

Internal scheduled-job identifier for the booking end..

boolean

Internal billing-processing state for this booking..

string

System-maintained local-time representation of FromTime..

string

System-maintained local-time representation of ToTime..

string

System-maintained local-time representation of InvoiceDate..

integer

System-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity..

string

System-maintained invoice number associated with this booking, populated when the booking is included in an invoice..

boolean

Read-only indicator that the associated invoice has been paid, populated when the booking is included in an invoice..

boolean

Read-only indicator that the associated invoice is still a draft, populated when the booking is included in an invoice..

boolean

Read-only indicator that the associated invoice has been voided, populated when the booking is included in an invoice..

boolean

Read-only indicator that the associated invoice is a credit note, populated when the booking is included in an invoice..

string

System-maintained serialized identifiers of customer rate entitlements used by this booking..

number

System-calculated price from the customer’s applicable rate entitlement..

string

System-calculated currency code for the customer rate entitlement used by this booking..

integer

System-calculated charge-period setting for the customer rate entitlement used by this booking..

integer

System-calculated number of customer rate uses consumed or available for this booking..

boolean

Whether to include a Zoom meeting invitation for this booking..

string

Internal Zoom event payload maintained by the integration..

string

UTC date and time when the booking was checked in through the booking workflow..

boolean

System-derived resource policy that cancels this booking when payment is not received..

boolean

System-derived resource policy that cancels this booking when no check-in occurs..

integer

Maximum occupancy detected by sensors in the selected resource during this booking..

number

System-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking..

number

System-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location..

number

System-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment..

number

System-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing..

string

Internal Microsoft 365 administrator calendar event identifier maintained by synchronization..

string

UTC date and time when the customer checked in for this booking..

string

UTC date and time when the customer checked out from this booking..

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,
  "Notified": 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,
  "CoworkerCheckedInAt": null,
  "CoworkerCheckedOutAt": 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 one Booking

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

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,
  "Notified": 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>",
  "CoworkerCheckedInAt": "<string>",
  "CoworkerCheckedOutAt": "<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