ResourceAccessRules
Search ResourceAccessRules
Search and list ResourceAccessRule records with filtering, sorting, and pagination.
GET
Search ResourceAccessRules
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-List role.Enums
eCancellationFeeType — CancellationFeeType values
eCancellationFeeType — CancellationFeeType values
Query Parameters
Pagination & Sorting
Filters
Filter by date from which this rule starts being evaluated. Null means no start-date restriction.
Filter by date after which this rule stops being evaluated. Null means no end-date restriction.
Filter by apply this rule only if the booking is more than this many minutes away from its start time.
Filter by minimum lead time (in hours) 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 order in which this rule is evaluated relative to other rules on the same resource. Lower values are evaluated first.
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 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 under this rule.
Filter by maximum time span (in months) over which a recurring booking series can extend under this rule.
Range Filters
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.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.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.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.Filter by apply this rule only if the booking is within this many minutes of its start time greater than or equal to this value.
Filter by apply this rule only if the booking is within this many minutes of its start time less than or equal to this value.
Filter by apply this rule only if the booking is more than this many minutes away from its start time greater than or equal to this value.
Filter by apply this rule only if the booking is more than this many minutes away from its start time less than or equal to this value.
Filter by apply this rule only if the booking price is at least this amount greater than or equal to this value.
Filter by apply this rule only if the booking price is at least this amount less than or equal to this value.
Filter by apply this rule only if the booking price does not exceed this amount greater than or equal to this value.
Filter by apply this rule only if the booking price does not exceed this amount less than or equal to this value.
Filter by maximum number of hours in advance a booking can be made. Null means no limit greater than or equal to this value.
Filter by maximum number of hours in advance a booking can be made. Null means no limit less than or equal to this value.
Filter by minimum lead time (in hours) required before a booking can start. Prevents last-minute bookings greater than or equal to this value.
Filter by minimum lead time (in hours) 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 maximum allowed duration for a single booking, in minutes greater than or equal to this value.
Filter by maximum allowed duration for a single booking, in minutes less than or equal to this value.
Filter by minimum allowed duration for a single booking, in minutes greater than or equal to this value.
Filter by minimum allowed duration for a single booking, in minutes less than or equal to this value.
Filter by count of resources this rule is currently applied to (read-only) greater than or equal to this value.
Filter by count of resources this rule is currently applied to (read-only) 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 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.
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.
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 under this rule greater than or equal to this value.
Filter by maximum number of occurrences allowed when creating a recurring booking under this rule less than or equal to this value.
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.
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.
Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of ResourceAccessRule records matching the query. See the Get one ResourceAccessRule endpoint for the full list of properties returned for each record.
Example Response