Search BookingAvailabilityExceptions

GET

api

spaces

bookingavailabilityexceptions

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

import requests

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

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/bookingavailabilityexceptions', 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 BookingAvailabilityException blocks one or more Resources from being booked during a specific date/time window. When a user tries to book a blocked resource, they see the configured Message instead of available time slots. Use exceptions for holidays, maintenance periods, or any other reason a resource should be temporarily unavailable. Set EveryYear to true for recurring annual closures (e.g. public holidays).

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

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 name of the location.

string

Filter by start date/time of the blocked period.

string

Filter by end date/time of the blocked period.

string

Filter by message shown to users who attempt to book a blocked resource.

boolean

Filter by whether this exception is currently enforced.

boolean

Filter by whether this exception recurs annually on the same dates.

string

Filter by comma-separated IDs of blocked resources.

string

Filter by names of the blocked resources.

Range Filters

string

Filter by start date/time of the blocked period greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by start date/time of the blocked period less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end date/time of the blocked period greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end date/time of the blocked period less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/bookingavailabilityexceptions?page=1&size=15&orderBy=Message&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by Message

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

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

data = response.json()

Response

200

BookingAvailabilityException[]

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

Partial records — The listing endpoint returns a summary representation of each BookingAvailabilityException. The following fields are not populated in the Records[] response: Message.To get all fields, fetch the full record using the Get one BookingAvailabilityException 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,
      "Resources": [],
      "FromTime": "2025-01-15T10:30:00Z",
      "ToTime": "2025-01-15T10:30:00Z",
      "Active": false,
      "EveryYear": false,
      "ResourceIds": null,
      "ResourceNames": 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": "BookingAvailabilityException Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Message",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one BookingAvailabilityExceptionRetrieve a single BookingAvailabilityException record by its Id.

Search BookingAvailabilityExceptions

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

import requests

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

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/bookingavailabilityexceptions', 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

Search BookingAvailabilityExceptions

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Message

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Message

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Message

Range filters

Response

200