> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search Resources > Search and list Resource records with filtering, sorting, and pagination. 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 booking** — `BookInAdvanceLimit` caps how far ahead a booking can be made; `LateBookingLimit` sets the minimum lead time before a booking can start. * **Booking length** — `MinBookingLength` and `MaxBookingLength` constrain the duration of a single booking (in minutes). * **Cancellation** — `LateCancellationLimit` 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 policy** — `NoReturnPolicy` 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 bookings** — `RepeatBookingQuantityLimit` and `RepeatBookingPeriodLimitInMonths` cap the number and time span of recurring bookings. * **Capacity** — `Allocation` 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. * **Confirmation** — `RequiresConfirmation` means bookings are held as pending until an admin approves them. * **Visibility** — `Visible` 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 | Value | Name | | ----- | ------------- | | 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 | | Value | Name | | ----- | ---------- | | 0 | None | | 1 | Absolute | | 2 | Percentage | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by Business Id. Filter by name of the location (read-only, resolved from BusinessId).. Filter by display name of the resource (e.g., 'Board Room A', 'Phone Booth 3').. Filter by built-in resource category used for system behaviour (e.g., MeetingRoom, HotDesk, PhoneBooth). Distinct from the custom ResourceType.. Filter by Resource Type Id. Filter by name of the resource type (read-only, resolved from ResourceTypeId).. Filter by free-text description shown to users when viewing the resource details.. Filter by Picture File Name. Filter by New Picture Url. Filter by Clear Picture File. Filter by custom HTML or text included in booking confirmation emails for this resource.. Filter by whether the resource is visible and bookable by end users. Hidden resources can still be booked by admins.. Filter by when true, bookings for this resource are held as pending until an admin approves them.. Filter by sort position when listing resources. Lower values appear first.. Filter by optional grouping label used to cluster related resources together in the UI (e.g., 'Floor 2').. Filter by amenity flag: resource has a projector.. Filter by amenity flag: resource has internet access.. Filter by amenity flag: resource has a conference phone.. Filter by amenity flag: resource has a standard phone.. Filter by amenity flag: resource has a whiteboard.. Filter by amenity flag: resource has a large display.. Filter by amenity flag: catering is available for this resource.. Filter by amenity flag: tea and coffee are available.. Filter by amenity flag: drinks are available.. Filter by amenity flag: resource has a security lock.. Filter by amenity flag: resource has CCTV coverage.. Filter by amenity flag: resource has a voice recorder.. Filter by amenity flag: resource has air conditioning.. Filter by amenity flag: resource has heating.. Filter by amenity flag: resource has natural light.. Filter by amenity flag: resource has a standing desk.. Filter by amenity flag: resource is located in a quiet zone.. Filter by amenity flag: resource has a wireless charger.. Filter by amenity flag: resource has a privacy screen.. Filter by amenity flag: resource is soundproof.. Filter by amenity flag: resource has video conferencing equipment.. Filter by amenity flag: resource has a dual display screen.. Filter by amenity flag: resource has a display screen.. Filter by amenity flag: resource has wireless presentation capabilities.. Filter by amenity flag: resource has a PA system.. Filter by amenity flag: resource has a desktop monitor.. Filter by amenity flag: resource has a flip chart.. Filter by amenity flag: resource has secure storage.. Filter by when true, overlapping bookings are permitted up to the Allocation capacity.. Filter by maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity.. Filter by when true, the total number of visitors added to a booking cannot exceed the Allocation capacity.. Filter by maximum number of days in advance a booking can be made for this resource. Null means no limit.. Filter by minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings.. Filter by cut-off in minutes before the booking start time. Cancellations after this point are considered late and may incur a fee.. Filter by minimum interval (in minutes) between consecutive bookings on this resource, used as a buffer for setup or cleaning.. Filter by cooldown in minutes: prevents the same user from booking this specific resource again within this window after their last booking ends.. Filter by cooldown in minutes: prevents the same user from booking any resource after booking this one, for the specified window\.. Filter by cooldown in minutes: prevents any user from booking this resource within the specified window after the previous booking ends.. Filter by maximum allowed duration for a single booking on this resource, in minutes.. Filter by minimum allowed duration for a single booking on this resource, in minutes.. Filter by jSON-encoded shifts configuration defining the resource's availability schedule.. Filter by Google Calendar Id. Filter by Kisi Group Id. Filter by Access Control Group Id. Filter by Access Control Group Ids. Filter by gPS longitude coordinate of the resource's physical location.. Filter by gPS latitude coordinate of the resource's physical location.. Filter by when true, this resource does not appear on the booking calendar view\.. Filter by when true, the resource is archived and hidden from all views. It cannot be booked.. Filter by when true, bookings for this resource use the location's shared Zoom account to create virtual meetings.. Filter by Zoom Access Token. Filter by Zoom Refresh Token. Filter by zoom user ID used to host virtual meetings when UseSharedZoomAccount is false.. Filter by timestamp of the last cleaning event for this resource.. Filter by Office365Calendar Id. Filter by comma-separated string of linked resource IDs (read-only alternative view of LinkedResources).. Filter by when true, only contacts (non-member customers) can book this resource.. Filter by when true, only active members (coworkers with a plan) can book this resource.. Filter by when true, only coworkers invoiced by this specific location can book this resource.. Filter by last value reported by an IoT occupancy sensor attached to this resource (read-only).. Filter by whether the IoT sensor currently reports this resource as occupied (read-only).. Filter by Cancellation Fee Product Id. Filter by name of the cancellation fee product (read-only, resolved from CancellationFeeProductId).. Filter by when true, a fee is charged for late cancellations (past the LateCancellationLimit).. Filter by how the cancellation fee is calculated: Absolute (fixed amount) or Percentage (of booking cost).. Filter by fixed cancellation fee amount. Used when CancellationFeeType is Absolute.. Filter by cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage.. Filter by maximum number of occurrences allowed when creating a recurring booking for this resource.. Filter by maximum time span (in months) over which a recurring booking series can extend.. ### Range Filters Filter by sort position when listing resources. Lower values appear first. greater than or equal to this value. Filter by sort position when listing resources. Lower values appear first. less than or equal to this value. Filter by maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity. greater than or equal to this value. Filter by maximum number of attendees or concurrent bookings allowed. Used with AllowMultipleBookings to control capacity. less than or equal to this value. 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. 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. Filter by minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings. greater than or equal to this value. Filter by minimum lead time (in minutes) required before a booking can start. Prevents last-minute bookings. less than or equal to this value. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. Filter by maximum allowed duration for a single booking on this resource, in minutes. greater than or equal to this value. Filter by maximum allowed duration for a single booking on this resource, in minutes. less than or equal to this value. Filter by minimum allowed duration for a single booking on this resource, in minutes. greater than or equal to this value. Filter by minimum allowed duration for a single booking on this resource, in minutes. less than or equal to this value. Filter by gPS longitude coordinate of the resource's physical location. greater than or equal to this value. Filter by gPS longitude coordinate of the resource's physical location. less than or equal to this value. Filter by gPS latitude coordinate of the resource's physical location. greater than or equal to this value. Filter by gPS latitude coordinate of the resource's physical location. less than or equal to this value. Filter by timestamp of the last cleaning event for this resource. greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by timestamp of the last cleaning event for this resource. less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by fixed cancellation fee amount. Used when CancellationFeeType is Absolute. greater than or equal to this value. Filter by fixed cancellation fee amount. Used when CancellationFeeType is Absolute. less than or equal to this value. Filter by cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage. greater than or equal to this value. Filter by cancellation fee as a percentage of the booking cost. Used when CancellationFeeType is Percentage. less than or equal to this value. Filter by maximum number of occurrences allowed when creating a recurring booking for this resource. greater than or equal to this value. Filter by maximum number of occurrences allowed when creating a recurring booking for this resource. less than or equal to this value. Filter by maximum time span (in months) over which a recurring booking series can extend. greater than or equal to this value. Filter by maximum time span (in months) over which a recurring booking series can extend. less than or equal to this value. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/resources?page=1&size=15&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/spaces/resources?Resource_Name=example-value&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} 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" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 The list of Resource records matching the query. See the [Get one Resource](/rest-api/spaces/get-resources-by-id) 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](/rest-api/spaces/get-resources-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "Records": [ { "BusinessId": 0, "BusinessName": null, "Name": "", "SystemResourceType": 0, "ResourceTypeId": 0, "ResourceTypeName": null, "PictureFileName": null, "NewPictureUrl": null, "ClearPictureFile": null, "Visible": false, "RequiresConfirmation": false, "GroupName": 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 } ```