Get one ResourceAccessRule

GET

api

spaces

resourceaccessrules

{id}

Get one ResourceAccessRule

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Resources": [
    123
  ],
  "Name": "<string>",
  "Active": true,
  "OnlyForContacts": true,
  "ApplyRuleFrom": "<string>",
  "ApplyRuleTo": "<string>",
  "ApplyIfWithinMinutesOfStart": 123,
  "ApplyIfMoreThanMinutesFromStart": 123,
  "ApplyIfPriceMin": 123,
  "ApplyIfPriceMax": 123,
  "BookInAdvanceLimit": 123,
  "LateBookingLimit": 123,
  "LateCancellationLimit": 123,
  "IntervalLimit": 123,
  "MaxBookingLength": 123,
  "MinBookingLength": 123,
  "AppliedResourcesCount": 123,
  "NoReturnPolicy": 123,
  "NoReturnPolicyAllResources": 123,
  "NoReturnPolicyAllUsers": 123,
  "RejectWithMessage": "<string>",
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "AllowedTariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "AllowedTeams": [
    123
  ],
  "EventCategories": [
    123
  ],
  "Courses": [
    123
  ],
  "EvaluationOrder": 123,
  "StopEvaluationIfRuleIsMet": true,
  "CancellationFeeProductId": 123,
  "CancellationFeeProductName": "<string>",
  "ChargeCancellationFee": true,
  "CancellationFeeType": 123,
  "CancellationFeeAmount": 123,
  "CancellationFeePercentage": 123,
  "RepeatBookingQuantityLimit": 123,
  "RepeatBookingPeriodLimitInMonths": 123,
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ResourceAccessRule defines overriding booking policies and restrictions for one or more resources or for all resources in a location, scoped by date/time, customer, team, plan, or other criteria. Rules are evaluated in EvaluationOrder and can optionally stop further evaluation when matched (StopEvaluationIfRuleIsMet). When a rule matches, it overrides the resource-level booking policies and restrictions for that booking. The booking-policy fields (BookInAdvanceLimit, LateBookingLimit, LateCancellationLimit, IntervalLimit, MaxBookingLength, MinBookingLength, NoReturnPolicy fields, 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. SCOPE: When the rule is connected to a Business and NO Resources are selected, it applies to ALL resources within that business AND all child businesses. When the rule is connected to one or more specific Resources, it applies ONLY to those resources. Use scope fields (OnlyForMembers, OnlyForContacts, Tariffs, Teams, Members, Courses, EventCategories) to control who the rule applies to, and allowed fields (AllowedTariffs, AllowedTeams) to control who can book when the rule fires.

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

Path Parameters

integer

required

The Id of the ResourceAccessRule record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/resourceaccessrules/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/resourceaccessrules/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/resourceaccessrules/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location linked to this rule.

integer[]

List of specific resources this rule applies to. When empty and BusinessId is set, applies to all resources in that location and all child locations. When one or more resources are specified, applies only to those specific resources.

string

Rule name.

boolean

Whether this rule is currently active and evaluated during booking.

boolean

When true, this rule applies only to contacts (non-member customers).

string

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

string

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

integer

Apply this rule only if the booking is within this many minutes of its start time.

integer

Apply this rule only if the booking is more than this many minutes away from its start time.

number

Apply this rule only if the booking price is at least this amount.

number

Apply this rule only if the booking price does not exceed this amount.

number

Maximum number of hours in advance a booking can be made. Null means no limit.

number

Minimum lead time (in hours) 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

Maximum allowed duration for a single booking, in minutes.

integer

Minimum allowed duration for a single booking, in minutes.

integer

Count of resources this rule is currently applied to (read-only).

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.

string

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

boolean

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

integer[]

List of pricing plans this rule applies to. When set, the rule only fires for customers on one of these plans.

integer[]

Only customers on one of these pricing plans are allowed to book when the rule applies to them.

integer[]

Specific customers this rule applies to. When set, the rule only fires for these customers.

integer[]

Teams this rule applies to. When set, the rule only fires for members of one of these teams.

integer[]

Only members of one of these teams are allowed to book when the rule applies to them.

integer[]

The rule applies only to customers who have attended (checked in to) an event in one of these categories.

integer[]

The rule applies only to customers who have completed one of these courses.

integer

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

boolean

When true, no further rules are evaluated after this one matches.

integer

Product to charge for late cancellations when ChargeCancellationFee is true.

string

Display value for CancellationFeeProduct.Name..

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

integer

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

string

Read-only, comma-separated names of the plans this rule applies to.

string

Read-only, comma-separated names of the teams this rule applies to.

string

Read-only, comma-separated full names of the customers this rule applies to.

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

{
  "BusinessId": 0,
  "Resources": [],
  "Name": "",
  "Active": false,
  "OnlyForContacts": false,
  "ApplyRuleFrom": null,
  "ApplyRuleTo": null,
  "ApplyIfWithinMinutesOfStart": null,
  "ApplyIfMoreThanMinutesFromStart": null,
  "ApplyIfPriceMin": null,
  "ApplyIfPriceMax": 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,
  "CancellationFeeType": 0,
  "CancellationFeeAmount": null,
  "CancellationFeePercentage": null,
  "RepeatBookingQuantityLimit": null,
  "RepeatBookingPeriodLimitInMonths": null,
  "TariffNames": null,
  "TeamNames": null,
  "CoworkerFullNames": 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
}

Get one ResourceAccessRule

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Resources": [
    123
  ],
  "Name": "<string>",
  "Active": true,
  "OnlyForContacts": true,
  "ApplyRuleFrom": "<string>",
  "ApplyRuleTo": "<string>",
  "ApplyIfWithinMinutesOfStart": 123,
  "ApplyIfMoreThanMinutesFromStart": 123,
  "ApplyIfPriceMin": 123,
  "ApplyIfPriceMax": 123,
  "BookInAdvanceLimit": 123,
  "LateBookingLimit": 123,
  "LateCancellationLimit": 123,
  "IntervalLimit": 123,
  "MaxBookingLength": 123,
  "MinBookingLength": 123,
  "AppliedResourcesCount": 123,
  "NoReturnPolicy": 123,
  "NoReturnPolicyAllResources": 123,
  "NoReturnPolicyAllUsers": 123,
  "RejectWithMessage": "<string>",
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "AllowedTariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "AllowedTeams": [
    123
  ],
  "EventCategories": [
    123
  ],
  "Courses": [
    123
  ],
  "EvaluationOrder": 123,
  "StopEvaluationIfRuleIsMet": true,
  "CancellationFeeProductId": 123,
  "CancellationFeeProductName": "<string>",
  "ChargeCancellationFee": true,
  "CancellationFeeType": 123,
  "CancellationFeeAmount": 123,
  "CancellationFeePercentage": 123,
  "RepeatBookingQuantityLimit": 123,
  "RepeatBookingPeriodLimitInMonths": 123,
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200