Skip to main content
GET
Get one Resource
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

integer
required
The Id of the Resource record to retrieve.

Code Examples

Response

200

integer
ID of the business linked to this record.
string
Name of the location (read-only, resolved from BusinessId)..
string
Display name of the resource (e.g., ‘Board Room A’, ‘Phone Booth 3’)..
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.
integer
ID of the resource type linked to this record.
string
Name of the resource type (read-only, resolved from ResourceTypeId)..
string
Free-text description shown to users when viewing the resource details..
string
Current file name of the picture (read-only; upload via the corresponding URL field).
string
URL of a new file to upload as the picture.
boolean
Set to true to remove the current picture file.
string
Custom HTML or text included in booking confirmation emails for this resource..
boolean
Whether the resource is visible and bookable by end users. Hidden resources can still be booked by admins..
boolean
When true, bookings for this resource are held as pending until an admin approves them..
integer
Sort position when listing resources. Lower values appear first..
string
Optional grouping label used to cluster related resources together in the UI (e.g., ‘Floor 2’)..
boolean
Amenity flag: resource has a projector..
boolean
Amenity flag: resource has internet access..
boolean
Amenity flag: resource has a conference phone..
boolean
Amenity flag: resource has a standard phone..
boolean
Amenity flag: resource has a whiteboard..
boolean
Amenity flag: resource has a large display..
boolean
Amenity flag: catering is available for this resource..
boolean
Amenity flag: tea and coffee are available..
boolean
Amenity flag: drinks are available..
boolean
Amenity flag: resource has a security lock..
boolean
Amenity flag: resource has CCTV coverage..
boolean
Amenity flag: resource has a voice recorder..
boolean
Amenity flag: resource has air conditioning..
boolean
Amenity flag: resource has heating..
boolean
Amenity flag: resource has natural light..
boolean
Amenity flag: resource has a standing desk..
boolean
Amenity flag: resource is located in a quiet zone..
boolean
Amenity flag: resource has a wireless charger..
boolean
Amenity flag: resource has a privacy screen..
boolean
Amenity flag: resource is soundproof..
boolean
Amenity flag: resource has video conferencing equipment..
boolean
Amenity flag: resource has a dual display screen..
boolean
Amenity flag: resource has a display screen..
boolean
Amenity flag: resource has wireless presentation capabilities..
boolean
Amenity flag: resource has a PA system..
boolean
Amenity flag: resource has a desktop monitor..
boolean
Amenity flag: resource has a flip chart..
boolean
Amenity flag: resource has secure storage..
boolean
When true, overlapping bookings are permitted up to the Allocation capacity..
integer
Maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity..
boolean
When true, the total number of visitors added to a booking cannot exceed the Allocation capacity..
number
Maximum number of days in advance a booking can be made for this resource. Null means no limit..
number
Minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings..
integer
Cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee..
integer
Minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning..
integer
Cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends..
integer
Cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window..
integer
Cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends..
integer
Maximum allowed duration for a single booking on this resource, in minutes..
integer
Minimum allowed duration for a single booking on this resource, in minutes..
integer[]
List of tariffs linked to this record.
integer[]
List of teams linked to this record.
string
JSON-encoded shifts configuration defining the resource’s availability schedule..
integer[]
List of linked resources linked to this record.
string
ID of the google calendar associated with this record.
string
ID of the kisi group associated with this record.
string
ID of the access control group associated with this record.
string
The access control group ids value for this resource.
number
GPS longitude coordinate of the resource’s physical location..
number
GPS latitude coordinate of the resource’s physical location..
boolean
When true, this resource does not appear on the booking calendar view..
boolean
When true, the resource is archived and hidden from all views. It cannot be booked..
boolean
When true, bookings for this resource use the location’s shared Zoom account to create virtual meetings..
string
The zoom access token value for this resource.
string
The zoom refresh token value for this resource.
string
Zoom user ID used to host virtual meetings when UseSharedZoomAccount is false..
string
Timestamp of the last cleaning event for this resource..
string
ID of the office365 calendar associated with this record.
string
Comma-separated string of linked resource IDs (read-only alternative view of LinkedResources)..
boolean
When true, only contacts (non-member customers) can book this resource..
boolean
When true, only active members (coworkers with a plan) can book this resource..
boolean
When true, only coworkers invoiced by this specific location can book this resource..
string
Last value reported by an IoT occupancy sensor attached to this resource (read-only)..
boolean
Whether the IoT sensor currently reports this resource as occupied (read-only)..
integer[]
List of booking availability exceptions linked to this record.
integer
ID of the cancellation fee product linked to this record.
string
Name of the cancellation fee product (read-only, resolved from CancellationFeeProductId)..
boolean
When true, a fee is charged for late cancellations (past the LateCancellationLimit)..
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.
number
Fixed cancellation fee amount. Used when CancellationFeeType is Absolute..
number
Cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage..
integer
Maximum number of occurrences allowed when creating a recurring booking for this resource..
integer
Maximum time span (in months) over which a recurring booking series can extend..
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