Search ResourceAccessRules

GET

api

spaces

resourceaccessrules

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

import requests

url = "https://spaces.nexudus.com/api/spaces/resourceaccessrules"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://spaces.nexudus.com/api/spaces/resourceaccessrules', 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 ResourceAccessRule defines additional booking policies and restrictions for one or more Resource(s) or for all resources in a location (Business), scoped by date/time, customer, team, plan, or other criteria. Rules are evaluated in EvaluationOrder and can optionally stop further evaluation when matched (StopEvaluationIfRuleIsMet). The booking-policy fields (BookInAdvanceLimit, LateBookingLimit, LateCancellationLimit, IntervalLimit, MaxBookingLength, MinBookingLength, NoReturnPolicy*, cancellation-fee fields, and repeat-booking limits) mirror those on Resource and carry the same semantics — they override the resource-level defaults when the rule matches. When BusinessId is set and Resources is empty, the rule applies to all resources in the business and its children (if any). When specific Resources are listed, the rule applies only to those resources.

Scope: who the rule applies to

OnlyForMembers / OnlyForContacts — quick toggles to limit the rule to members or contacts.
Tariffs — pricing plans this rule applies to. When set, the rule only fires for customers on one of these plans.
Teams — teams this rule applies to. When set, the rule only fires for members of one of these teams.
Courses — the rule applies only to customers who have completed one of these courses.
EventCategories — the rule applies only to customers who have attended (checked in to) an event in one of these categories.

Scope: who is allowed to book when the rule fires

AllowedTariffs — only customers on one of these plans are allowed to book when the rule applies to them.
AllowedTeams — only members of one of these teams are allowed to book when the rule applies to them.

List mutation helpers

For each list field (Tariffs, AllowedTariffs, Teams, AllowedTeams, Members, EventCategories, Courses) there are Added* and Removed* variants that append or remove entries on update without replacing the full list.

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 ResourceAccessRule-List role.

Enums

eCancellationFeeType — CancellationFeeType values

Value	Name
0	None
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 business linked to this record.

string

Filter by rule name.

boolean

Filter by whether this rule is currently active and evaluated during booking..

boolean

Filter by when true, this rule applies only to contacts (non-member customers)..

string

Filter by date from which this rule starts being evaluated. Null means no start-date restriction..

string

Filter by date after which this rule stops being evaluated. Null means no end-date restriction..

number

Filter by maximum number of days in advance a booking can be made. 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 maximum allowed duration for a single booking, in minutes..

integer

Filter by minimum allowed duration for a single booking, in minutes..

integer

Filter by the applied resources count value for this resource access rule.

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

string

Filter by message shown to the user when their booking is rejected by this rule..

boolean

Filter by when true, this rule applies only to active members (coworkers with a plan)..

integer

Filter by order in which this rule is evaluated relative to other rules on the same resource. Lower values are evaluated first..

boolean

Filter by when true, no further rules are evaluated after this one matches..

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 under this rule..

integer

Filter by maximum time span (in months) over which a recurring booking series can extend under this rule..

Range Filters

string

Filter by date from which this rule starts being evaluated. Null means no start-date restriction. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date from which this rule starts being evaluated. Null means no start-date restriction. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date after which this rule stops being evaluated. Null means no end-date restriction. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date after which this rule stops being evaluated. Null means no end-date restriction. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by maximum number of days in advance a booking can be made. 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. 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 maximum allowed duration for a single booking, in minutes. greater than or equal to this value.

integer

Filter by maximum allowed duration for a single booking, in minutes. less than or equal to this value.

integer

Filter by minimum allowed duration for a single booking, in minutes. greater than or equal to this value.

integer

Filter by minimum allowed duration for a single booking, in minutes. less than or equal to this value.

integer

Filter by the applied resources count value for this resource access rule greater than or equal to this value.

integer

Filter by the applied resources count value for this resource access rule 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 order in which this rule is evaluated relative to other rules on the same resource. Lower values are evaluated first. greater than or equal to this value.

integer

Filter by order in which this rule is evaluated relative to other rules on the same resource. Lower values are evaluated first. less than or equal to this value.

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 under this rule. greater than or equal to this value.

integer

Filter by maximum number of occurrences allowed when creating a recurring booking under this rule. less than or equal to this value.

integer

Filter by maximum time span (in months) over which a recurring booking series can extend under this rule. greater than or equal to this value.

integer

Filter by maximum time span (in months) over which a recurring booking series can extend under this rule. 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/resourceaccessrules?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resourceaccessrules?' + 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/resourceaccessrules',
    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/resourceaccessrules?ResourceAccessRule_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resourceaccessrules?' + new URLSearchParams({
    ResourceAccessRule_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/resourceaccessrules',
    params={
        'ResourceAccessRule_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/resourceaccessrules?from_ResourceAccessRule_UpdatedOn=2025-01-01T00:00&to_ResourceAccessRule_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resourceaccessrules?' + new URLSearchParams({
    from_ResourceAccessRule_UpdatedOn: '2025-01-01T00:00',
    to_ResourceAccessRule_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/resourceaccessrules',
    params={
        'from_ResourceAccessRule_UpdatedOn': '2025-01-01T00:00',
        'to_ResourceAccessRule_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ResourceAccessRule[]

The list of ResourceAccessRule records matching the query. See the Get one ResourceAccessRule endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each ResourceAccessRule. The following fields are not populated in the Records[] response: CancellationFeeType, CancellationFeeAmount, CancellationFeePercentage.To get all fields, fetch the full record using the Get one ResourceAccessRule 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,
      "Resources": [],
      "Name": "",
      "Active": false,
      "OnlyForContacts": false,
      "ApplyRuleFrom": null,
      "ApplyRuleTo": null,
      "BookInAdvanceLimit": null,
      "LateBookingLimit": null,
      "LateCancellationLimit": null,
      "IntervalLimit": null,
      "MaxBookingLength": null,
      "MinBookingLength": null,
      "AppliedResourcesCount": 0,
      "NoReturnPolicy": null,
      "NoReturnPolicyAllResources": null,
      "NoReturnPolicyAllUsers": null,
      "RejectWithMessage": null,
      "OnlyForMembers": false,
      "Tariffs": [],
      "AllowedTariffs": [],
      "Members": [],
      "Teams": [],
      "AllowedTeams": [],
      "EventCategories": [],
      "Courses": [],
      "EvaluationOrder": 0,
      "StopEvaluationIfRuleIsMet": false,
      "CancellationFeeProductId": null,
      "CancellationFeeProductName": null,
      "ChargeCancellationFee": false,
      "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": "ResourceAccessRule 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
}

Get one ResourceAccessRuleRetrieve a single ResourceAccessRule record by its Id.

Search ResourceAccessRules

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

import requests

url = "https://spaces.nexudus.com/api/spaces/resourceaccessrules"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://spaces.nexudus.com/api/spaces/resourceaccessrules', 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

Scope: who the rule applies to

Scope: who is allowed to book when the rule fires

List mutation helpers

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Scope: who the rule applies to

​Scope: who is allowed to book when the rule fires

​List mutation helpers

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Scope: who the rule applies to

Scope: who is allowed to book when the rule fires

List mutation helpers

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200