Skip to main content
GET
Search Resources
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-List role.

Enums

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

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

Range Filters

integer
Filter by sort position when listing resources. Lower values appear first. greater than or equal to this value.
integer
Filter by sort position when listing resources. Lower values appear first. less than or equal to this value.
integer
Filter by maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity. greater than or equal to this value.
integer
Filter by maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity. less than or equal to this value.
number
Filter by maximum number of days in advance a booking can be made for this resource. Null means no limit. greater than or equal to this value.
number
Filter by maximum number of days in advance a booking can be made for this resource. Null means no limit. less than or equal to this value.
number
Filter by minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings. greater than or equal to this value.
number
Filter by minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings. less than or equal to this value.
integer
Filter by cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee. greater than or equal to this value.
integer
Filter by cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee. less than or equal to this value.
integer
Filter by minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning. greater than or equal to this value.
integer
Filter by minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning. less than or equal to this value.
integer
Filter by cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends. greater than or equal to this value.
integer
Filter by cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends. less than or equal to this value.
integer
Filter by cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window. greater than or equal to this value.
integer
Filter by cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window. less than or equal to this value.
integer
Filter by cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends. greater than or equal to this value.
integer
Filter by cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends. less than or equal to this value.
integer
Filter by maximum allowed duration for a single booking on this resource, in minutes. greater than or equal to this value.
integer
Filter by maximum allowed duration for a single booking on this resource, in minutes. less than or equal to this value.
integer
Filter by minimum allowed duration for a single booking on this resource, in minutes. greater than or equal to this value.
integer
Filter by minimum allowed duration for a single booking on this resource, in minutes. less than or equal to this value.
number
Filter by gPS longitude coordinate of the resource’s physical location. greater than or equal to this value.
number
Filter by gPS longitude coordinate of the resource’s physical location. less than or equal to this value.
number
Filter by gPS latitude coordinate of the resource’s physical location. greater than or equal to this value.
number
Filter by gPS latitude coordinate of the resource’s physical location. less than or equal to this value.
string
Filter by timestamp of the last cleaning event for this resource. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by timestamp of the last cleaning event for this resource. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
number
Filter by fixed cancellation fee amount. Used when CancellationFeeType is Absolute. greater than or equal to this value.
number
Filter by fixed cancellation fee amount. Used when CancellationFeeType is Absolute. less than or equal to this value.
number
Filter by cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage. greater than or equal to this value.
number
Filter by cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage. less than or equal to this value.
integer
Filter by maximum number of occurrences allowed when creating a recurring booking for this resource. greater than or equal to this value.
integer
Filter by maximum number of occurrences allowed when creating a recurring booking for this resource. less than or equal to this value.
integer
Filter by maximum time span (in months) over which a recurring booking series can extend. greater than or equal to this value.
integer
Filter by maximum time span (in months) over which a recurring booking series can extend. less than or equal to this value.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

Resource[]
The list of Resource records matching the query. See the Get one Resource endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each Resource. The following fields are not populated in the Records[] response: Description, EmailConfirmationContent, DisplayOrder, Projector, Internet, ConferencePhone, StandardPhone, WhiteBoard, LargeDisplay, Catering, TeaAndCoffee, Drinks, SecurityLock, CCTV, VoiceRecorder, AirConditioning, Heating, NaturalLight, StandingDesk, QuietZone, WirelessCharger, PrivacyScreen, Soundproof, VideoConferencing, DualDisplayScreen, DisplayScreen, WirelessPresentation, PaSystem, DesktopMonitor, FlipChart, SecureStorage, AllowMultipleBookings, Allocation, LimitVisitorsToAllocation, BookInAdvanceLimit, LateBookingLimit, LateCancellationLimit, IntervalLimit, NoReturnPolicy, NoReturnPolicyAllResources, NoReturnPolicyAllUsers, MaxBookingLength, MinBookingLength, Shifts, HideInCalendar, UseSharedZoomAccount, OnlyForContacts, OnlyForMembers, OnlyForInvoicingBusiness, ChargeCancellationFee, CancellationFeeType, CancellationFeeAmount, CancellationFeePercentage, RepeatBookingQuantityLimit, RepeatBookingPeriodLimitInMonths.To get all fields, fetch the full record using the Get one Resource endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response