Search Resources

GET

api

spaces

resources

Search Resources

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/resources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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’. Pricing is not set directly on a resource or its type. Instead, one or more booking rates (ExtraService 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 also need a different type. You must know the ResourceTypeId before creating a resource.

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

eResourceType — SystemResourceType values

Value	Name
1	MeetingRoom
2	HotDesk
3	PrivateOffice
4	EventSpace
5	Lab
6	Kitchen
7	TreatmentRoom
9	StorageUnit
10	Machine
11	DayPass
12	PhoneBooth
99	Other

eCancellationFeeType — CancellationFeeType values

Value	Name
1	Absolute
2	Percentage

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 location where this resource is located..

string

Filter by display value for Business.Name..

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). AI agents use this value to guide customers asking for specific type of services to the right resource. Distinct from the custom ResourceType..

integer

Filter by iD of the resource type assigned to this resource. The resource inherits every applicable booking rate (ExtraService) whose ResourceTypes relationship includes this type; use a different resource type when a resource needs a different set of rates..

string

Filter by display value for ResourceType.Name..

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 published and bookable by end users from the Members Portal and the app. Hidden resources can still be booked by admins..

boolean

Filter by when true, bookings for this resource are held as pending until an admin user 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 and Allocation controls the maximum number of concurrent bookings. When false, only one booking at a time is allowed and Allocation is purely informational (physical capacity)..

integer

Filter by when AllowMultipleBookings is true, this is the maximum number of overlapping bookings accepted. When AllowMultipleBookings is false, this is informational physical capacity (e.g., number of seats) and does not affect booking limits..

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 hours in advance a booking can be made for this resource. Null means no limit..

number

Filter by minimum lead time in hours required before a booking can start. Negative values allow bookings after the start time..

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 fixed interval in minutes used for booking start times, end times, and durations. Must be a non-zero multiple of 15 minutes..

integer

Filter by required gap in minutes between bookings made by the same customer or team for this resource..

integer

Filter by required gap in minutes before the same customer or team can book this or any other resource..

integer

Filter by required gap in minutes between all consecutive bookings for this resource, regardless of customer..

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 comma-separated list of shifts defining when the resource is available. Each shift uses the format ‘NAME: START_TIME->END_TIME’ where NAME is a descriptive label (cannot contain colons), and times are in 24-hour HH:MM format. Example: ‘FULL DAY (9AM - 6PM): 09:00->18:00, MORNING (9AM - 1PM): 09:00->13:00, AFTERNOON (1PM - 6PM): 13:00->18:00’. The shift name must NOT contain ’:’ as it breaks parsing..

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 (deprecated).

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 in the admin panel. Use ‘Visible’ to control if the resource is visible in the Members Portal and the App.

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 view of LinkedResources)..

boolean

Filter by when true, only contacts (customers without an active contract for a plan) can book this resource..

boolean

Filter by when true, only active members (customers with an active contract for a plan) can book this resource..

boolean

Filter by when true, only customers with a home location set to the resource’s 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 product representing the cancellation fee linked to this resource.

string

Filter by display value for CancellationFeeProduct.Name..

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

number

Filter by maximum number of hours 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 hours 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 hours required before a booking can start. Negative values allow bookings after the start time. greater than or equal to this value.

number

Filter by minimum lead time in hours required before a booking can start. Negative values allow bookings after the start time. 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 fixed interval in minutes used for booking start times, end times, and durations. Must be a non-zero multiple of 15 minutes. greater than or equal to this value.

integer

Filter by fixed interval in minutes used for booking start times, end times, and durations. Must be a non-zero multiple of 15 minutes. less than or equal to this value.

integer

Filter by required gap in minutes between bookings made by the same customer or team for this resource. greater than or equal to this value.

integer

Filter by required gap in minutes between bookings made by the same customer or team for this resource. less than or equal to this value.

integer

Filter by required gap in minutes before the same customer or team can book this or any other resource. greater than or equal to this value.

integer

Filter by required gap in minutes before the same customer or team can book this or any other resource. less than or equal to this value.

integer

Filter by required gap in minutes between all consecutive bookings for this resource, regardless of customer. greater than or equal to this value.

integer

Filter by required gap in minutes between all consecutive bookings for this resource, regardless of customer. 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

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/resources?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resources?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/resources',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/resources?Resource_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resources?' + new URLSearchParams({
    Resource_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/resources',
    params={
        'Resource_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/resources?from_Resource_UpdatedOn=2025-01-01T00:00&to_Resource_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resources?' + new URLSearchParams({
    from_Resource_UpdatedOn: '2025-01-01T00:00',
    to_Resource_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/resources',
    params={
        'from_Resource_UpdatedOn': '2025-01-01T00:00',
        'to_Resource_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "SystemResourceType": 0,
      "ResourceTypeId": 0,
      "ResourceTypeName": null,
      "PictureFileName": null,
      "NewPictureUrl": null,
      "ClearPictureFile": null,
      "Visible": false,
      "RequiresConfirmation": false,
      "DisplayOrder": 0,
      "GroupName": null,
      "Allocation": null,
      "Tariffs": [],
      "Teams": [],
      "LinkedResources": [],
      "GoogleCalendarId": null,
      "KisiGroupId": null,
      "AccessControlGroupId": null,
      "AccessControlGroupIds": null,
      "Longitude": null,
      "Latitude": null,
      "Archived": false,
      "ZoomAccessToken": null,
      "ZoomRefreshToken": null,
      "ZoomUserId": null,
      "LastCleanedAt": null,
      "Office365CalendarId": null,
      "LinkedResourceIds": null,
      "SensorLastValue": null,
      "IsSensorOccupied": false,
      "BookingAvailabilityExceptions": [],
      "CancellationFeeProductId": null,
      "CancellationFeeProductName": 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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search Resources

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/resources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200