Skip to main content
GET
/
api
/
spaces
/
resources
/
{id}
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "SystemResourceType": 123,
  "ResourceTypeId": 123,
  "ResourceTypeName": "<string>",
  "Description": "<string>",
  "PictureFileName": "<string>",
  "NewPictureUrl": "<string>",
  "ClearPictureFile": true,
  "EmailConfirmationContent": "<string>",
  "Visible": true,
  "RequiresConfirmation": true,
  "DisplayOrder": 123,
  "GroupName": "<string>",
  "Projector": true,
  "Internet": true,
  "ConferencePhone": true,
  "StandardPhone": true,
  "WhiteBoard": true,
  "LargeDisplay": true,
  "Catering": true,
  "TeaAndCoffee": true,
  "Drinks": true,
  "SecurityLock": true,
  "CCTV": true,
  "VoiceRecorder": true,
  "AirConditioning": true,
  "Heating": true,
  "NaturalLight": true,
  "StandingDesk": true,
  "QuietZone": true,
  "WirelessCharger": true,
  "PrivacyScreen": true,
  "Soundproof": true,
  "VideoConferencing": true,
  "DualDisplayScreen": true,
  "DisplayScreen": true,
  "WirelessPresentation": true,
  "PaSystem": true,
  "DesktopMonitor": true,
  "FlipChart": true,
  "SecureStorage": true,
  "AllowMultipleBookings": true,
  "Allocation": 123,
  "LimitVisitorsToAllocation": true,
  "BookInAdvanceLimit": 123,
  "LateBookingLimit": 123,
  "LateCancellationLimit": 123,
  "IntervalLimit": 123,
  "NoReturnPolicy": 123,
  "NoReturnPolicyAllResources": 123,
  "NoReturnPolicyAllUsers": 123,
  "MaxBookingLength": 123,
  "MinBookingLength": 123,
  "Tariffs": [
    123
  ],
  "Teams": [
    123
  ],
  "Shifts": "<string>",
  "LinkedResources": [
    123
  ],
  "GoogleCalendarId": "<string>",
  "KisiGroupId": "<string>",
  "AccessControlGroupId": "<string>",
  "AccessControlGroupIds": "<string>",
  "Longitude": 123,
  "Latitude": 123,
  "HideInCalendar": true,
  "Archived": true,
  "UseSharedZoomAccount": true,
  "ZoomAccessToken": "<string>",
  "ZoomRefreshToken": "<string>",
  "ZoomUserId": "<string>",
  "LastCleanedAt": "<string>",
  "Office365CalendarId": "<string>",
  "LinkedResourceIds": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "OnlyForInvoicingBusiness": true,
  "SensorLastValue": "<string>",
  "IsSensorOccupied": true,
  "BookingAvailabilityExceptions": [
    123
  ],
  "CancellationFeeProductId": 123,
  "CancellationFeeProductName": "<string>",
  "ChargeCancellationFee": true,
  "CancellationFeeType": 123,
  "CancellationFeeAmount": 123,
  "CancellationFeePercentage": 123,
  "RepeatBookingQuantityLimit": 123,
  "RepeatBookingPeriodLimitInMonths": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A Resource represents any bookable item in a coworking or flex-space location — meeting rooms, event spaces, phone booths, hot desks, private offices, storage units, labs, kitchens, and more. Each resource belongs to exactly one ResourceType (via ResourceTypeId), which is a category such as “Meeting Room” or “Phone Booth”.
Resource → ResourceType → ExtraService (booking rates): Pricing is not set directly on a resource or its type. Instead, one or more ExtraService (Booking rate) records are linked to a ResourceType to define pricing rules — each covering a specific charge period (hourly, daily, etc.) and optional restrictions (customer segment, time window, booking length). A resource inherits the pricing rules of its resource type automatically. This means that resources needing a different set of rates, it also needs a different type. You must know the ResourceTypeId before creating a resource.
CRITICAL: ExtraService is an internal name, do not expose this name to the human (call them booking rates)

Booking policies and restrictions

Each resource can define its own booking policies that override or extend location-level defaults:
  • Advance / late bookingBookInAdvanceLimit caps how far ahead a booking can be made; LateBookingLimit sets the minimum lead time before a booking can start.
  • Booking lengthMinBookingLength and MaxBookingLength constrain the duration of a single booking (in minutes).
  • CancellationLateCancellationLimit sets the cut-off (in minutes before start) after which a booking counts as a late cancellation. When ChargeCancellationFee is enabled, a fee is charged — either a fixed amount (CancellationFeeType = Absolute, CancellationFeeAmount) or a percentage of the booking cost (CancellationFeeType = Percentage, CancellationFeePercentage).
  • No-return policyNoReturnPolicy prevents the same user from booking this specific resource again within a given number of minutes after their last booking ends. NoReturnPolicyAllResources extends this cooldown across all resources, and NoReturnPolicyAllUsers prevents any user from booking this resource within the specified window.
  • Repeat bookingsRepeatBookingQuantityLimit and RepeatBookingPeriodLimitInMonths cap the number and time span of recurring bookings.
  • CapacityAllocation sets the maximum number of attendees. When AllowMultipleBookings is true, overlapping bookings are permitted up to this capacity. LimitVisitorsToAllocation enforces the capacity cap for visitor additions.
  • ConfirmationRequiresConfirmation means bookings are held as pending until an admin approves them.
  • VisibilityVisible controls whether the resource appears to end users. Archived hides the resource from all views.

Access restrictions

  • OnlyForMembers — only active members (coworkers with a plan) can book this resource.
  • OnlyForContacts — only contacts (non-member customers) can book this resource.
  • Tariffs — restrict bookings to coworkers on specific pricing plans.
  • Teams — restrict bookings to members of specific teams.

Amenity flags

Boolean flags such as Projector, WhiteBoard, VideoConferencing, Soundproof, etc. describe the physical amenities available in the resource. These are used for filtering and display purposes.

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

Path Parameters

id
integer
required
The Id of the Resource record to retrieve.

Code Examples

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

Response

200

BusinessId
integer
Business Id.
BusinessName
string
Name of the location (read-only, resolved from BusinessId)..
Name
string
Display name of the resource (e.g., ‘Board Room A’, ‘Phone Booth 3’)..
SystemResourceType
integer
Built-in resource category used for system behaviour (e.g., MeetingRoom, HotDesk, PhoneBooth). Distinct from the custom ResourceType.. See eResourceType enum values: 0 = None, 1 = MeetingRoom, 2 = HotDesk, 3 = PrivateOffice, 4 = EventSpace, 5 = Lab, 6 = Kitchen, 7 = TreatmentRoom, 9 = StorageUnit, 10 = Machine, 11 = DayPass, 12 = PhoneBooth, 99 = Other.
ResourceTypeId
integer
Resource Type Id.
ResourceTypeName
string
Name of the resource type (read-only, resolved from ResourceTypeId)..
Description
string
Free-text description shown to users when viewing the resource details..
PictureFileName
string
Picture File Name.
NewPictureUrl
string
New Picture Url.
ClearPictureFile
boolean
Clear Picture File.
EmailConfirmationContent
string
Custom HTML or text included in booking confirmation emails for this resource..
Visible
boolean
Whether the resource is visible and bookable by end users. Hidden resources can still be booked by admins..
RequiresConfirmation
boolean
When true, bookings for this resource are held as pending until an admin approves them..
DisplayOrder
integer
Sort position when listing resources. Lower values appear first..
GroupName
string
Optional grouping label used to cluster related resources together in the UI (e.g., ‘Floor 2’)..
Projector
boolean
Amenity flag: resource has a projector..
Internet
boolean
Amenity flag: resource has internet access..
ConferencePhone
boolean
Amenity flag: resource has a conference phone..
StandardPhone
boolean
Amenity flag: resource has a standard phone..
WhiteBoard
boolean
Amenity flag: resource has a whiteboard..
LargeDisplay
boolean
Amenity flag: resource has a large display..
Catering
boolean
Amenity flag: catering is available for this resource..
TeaAndCoffee
boolean
Amenity flag: tea and coffee are available..
Drinks
boolean
Amenity flag: drinks are available..
SecurityLock
boolean
Amenity flag: resource has a security lock..
CCTV
boolean
Amenity flag: resource has CCTV coverage..
VoiceRecorder
boolean
Amenity flag: resource has a voice recorder..
AirConditioning
boolean
Amenity flag: resource has air conditioning..
Heating
boolean
Amenity flag: resource has heating..
NaturalLight
boolean
Amenity flag: resource has natural light..
StandingDesk
boolean
Amenity flag: resource has a standing desk..
QuietZone
boolean
Amenity flag: resource is located in a quiet zone..
WirelessCharger
boolean
Amenity flag: resource has a wireless charger..
PrivacyScreen
boolean
Amenity flag: resource has a privacy screen..
Soundproof
boolean
Amenity flag: resource is soundproof..
VideoConferencing
boolean
Amenity flag: resource has video conferencing equipment..
DualDisplayScreen
boolean
Amenity flag: resource has a dual display screen..
DisplayScreen
boolean
Amenity flag: resource has a display screen..
WirelessPresentation
boolean
Amenity flag: resource has wireless presentation capabilities..
PaSystem
boolean
Amenity flag: resource has a PA system..
DesktopMonitor
boolean
Amenity flag: resource has a desktop monitor..
FlipChart
boolean
Amenity flag: resource has a flip chart..
SecureStorage
boolean
Amenity flag: resource has secure storage..
AllowMultipleBookings
boolean
When true, overlapping bookings are permitted up to the Allocation capacity..
Allocation
integer
Maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity..
LimitVisitorsToAllocation
boolean
When true, the total number of visitors added to a booking cannot exceed the Allocation capacity..
BookInAdvanceLimit
number
Maximum number of days in advance a booking can be made for this resource. Null means no limit..
LateBookingLimit
number
Minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings..
LateCancellationLimit
integer
Cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee..
IntervalLimit
integer
Minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning..
NoReturnPolicy
integer
Cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends..
NoReturnPolicyAllResources
integer
Cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window..
NoReturnPolicyAllUsers
integer
Cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends..
MaxBookingLength
integer
Maximum allowed duration for a single booking on this resource, in minutes..
MinBookingLength
integer
Minimum allowed duration for a single booking on this resource, in minutes..
Tariffs
integer[]
Tariffs.
Teams
integer[]
Teams.
Shifts
string
JSON-encoded shifts configuration defining the resource’s availability schedule..
LinkedResources
integer[]
Linked Resources.
GoogleCalendarId
string
Google Calendar Id.
KisiGroupId
string
Kisi Group Id.
AccessControlGroupId
string
Access Control Group Id.
AccessControlGroupIds
string
Access Control Group Ids.
Longitude
number
GPS longitude coordinate of the resource’s physical location..
Latitude
number
GPS latitude coordinate of the resource’s physical location..
HideInCalendar
boolean
When true, this resource does not appear on the booking calendar view..
Archived
boolean
When true, the resource is archived and hidden from all views. It cannot be booked..
UseSharedZoomAccount
boolean
When true, bookings for this resource use the location’s shared Zoom account to create virtual meetings..
ZoomAccessToken
string
Zoom Access Token.
ZoomRefreshToken
string
Zoom Refresh Token.
ZoomUserId
string
Zoom user ID used to host virtual meetings when UseSharedZoomAccount is false..
LastCleanedAt
string
Timestamp of the last cleaning event for this resource..
Office365CalendarId
string
Office365Calendar Id.
LinkedResourceIds
string
Comma-separated string of linked resource IDs (read-only alternative view of LinkedResources)..
OnlyForContacts
boolean
When true, only contacts (non-member customers) can book this resource..
OnlyForMembers
boolean
When true, only active members (coworkers with a plan) can book this resource..
OnlyForInvoicingBusiness
boolean
When true, only coworkers invoiced by this specific location can book this resource..
SensorLastValue
string
Last value reported by an IoT occupancy sensor attached to this resource (read-only)..
IsSensorOccupied
boolean
Whether the IoT sensor currently reports this resource as occupied (read-only)..
BookingAvailabilityExceptions
integer[]
Booking Availability Exceptions.
CancellationFeeProductId
integer
Cancellation Fee Product Id.
CancellationFeeProductName
string
Name of the cancellation fee product (read-only, resolved from CancellationFeeProductId)..
ChargeCancellationFee
boolean
When true, a fee is charged for late cancellations (past the LateCancellationLimit)..
CancellationFeeType
integer
How the cancellation fee is calculated: Absolute (fixed amount) or Percentage (of booking cost).. See eCancellationFeeType enum values: 0 = None, 1 = Absolute, 2 = Percentage.
CancellationFeeAmount
number
Fixed cancellation fee amount. Used when CancellationFeeType is Absolute..
CancellationFeePercentage
number
Cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage..
RepeatBookingQuantityLimit
integer
Maximum number of occurrences allowed when creating a recurring booking for this resource..
RepeatBookingPeriodLimitInMonths
integer
Maximum time span (in months) over which a recurring booking series can extend..
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
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "SystemResourceType": 0,
  "ResourceTypeId": 0,
  "ResourceTypeName": null,
  "Description": null,
  "PictureFileName": null,
  "NewPictureUrl": null,
  "ClearPictureFile": null,
  "EmailConfirmationContent": null,
  "Visible": false,
  "RequiresConfirmation": false,
  "DisplayOrder": 0,
  "GroupName": null,
  "Projector": false,
  "Internet": false,
  "ConferencePhone": false,
  "StandardPhone": false,
  "WhiteBoard": false,
  "LargeDisplay": false,
  "Catering": false,
  "TeaAndCoffee": false,
  "Drinks": false,
  "SecurityLock": false,
  "CCTV": false,
  "VoiceRecorder": false,
  "AirConditioning": false,
  "Heating": false,
  "NaturalLight": false,
  "StandingDesk": false,
  "QuietZone": false,
  "WirelessCharger": false,
  "PrivacyScreen": false,
  "Soundproof": false,
  "VideoConferencing": false,
  "DualDisplayScreen": false,
  "DisplayScreen": false,
  "WirelessPresentation": false,
  "PaSystem": false,
  "DesktopMonitor": false,
  "FlipChart": false,
  "SecureStorage": false,
  "AllowMultipleBookings": false,
  "Allocation": null,
  "LimitVisitorsToAllocation": false,
  "BookInAdvanceLimit": null,
  "LateBookingLimit": null,
  "LateCancellationLimit": null,
  "IntervalLimit": null,
  "NoReturnPolicy": null,
  "NoReturnPolicyAllResources": null,
  "NoReturnPolicyAllUsers": null,
  "MaxBookingLength": null,
  "MinBookingLength": null,
  "Tariffs": [],
  "Teams": [],
  "Shifts": null,
  "LinkedResources": [],
  "GoogleCalendarId": null,
  "KisiGroupId": null,
  "AccessControlGroupId": null,
  "AccessControlGroupIds": null,
  "Longitude": null,
  "Latitude": null,
  "HideInCalendar": false,
  "Archived": false,
  "UseSharedZoomAccount": false,
  "ZoomAccessToken": null,
  "ZoomRefreshToken": null,
  "ZoomUserId": null,
  "LastCleanedAt": null,
  "Office365CalendarId": null,
  "LinkedResourceIds": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "OnlyForInvoicingBusiness": false,
  "SensorLastValue": null,
  "IsSensorOccupied": false,
  "BookingAvailabilityExceptions": [],
  "CancellationFeeProductId": null,
  "CancellationFeeProductName": null,
  "ChargeCancellationFee": false,
  "CancellationFeeType": 0,
  "CancellationFeeAmount": null,
  "CancellationFeePercentage": null,
  "RepeatBookingQuantityLimit": null,
  "RepeatBookingPeriodLimitInMonths": 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": "Resource Example",
  "LocalizationDetails": null,
  "CustomFields": null
}