Search AccessTokens

GET

api

spaces

accesstokens

Search AccessTokens

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

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

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

WiFi access tokens are location-scoped network access codes for customers, visitors, bookings, and events, with a WiFi-minute allowance and optional validity window or user limit.

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 AccessToken-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 location that owns this WiFi access token..

string

Filter by required unique code used to authenticate to the location’s WiFi network..

string

Filter by optional operator-facing label, such as the related visitor, booking, or event..

integer

Filter by non-negative total number of WiFi minutes granted when the token is created..

string

Filter by optional UTC date and time after which the token can be used; no value allows use immediately..

string

Filter by optional UTC expiration date and time; no value means the token does not expire by date..

integer

Filter by optional minimum-one limit on users or devices permitted by the WiFi integration..

integer

Filter by read-only remaining WiFi minutes, initialized from MinutesIncluded when the token is created and reduced by network use..

string

Filter by optional comma-separated list of device MAC addresses associated with this token; stored in lowercase..

string

Filter by internal GUID linking this token to the booking that created it; set by booking automation, not by operators..

string

Filter by internal GUID linking this token to the visitor that created it; set by visitor automation, not by operators..

string

Filter by read-only UTC date and time when the token last accessed the WiFi network..

Range Filters

integer

Filter by non-negative total number of WiFi minutes granted when the token is created. greater than or equal to this value.

integer

Filter by non-negative total number of WiFi minutes granted when the token is created. less than or equal to this value.

string

Filter by optional UTC date and time after which the token can be used; no value allows use immediately. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time after which the token can be used; no value allows use immediately. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC expiration date and time; no value means the token does not expire by date. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC expiration date and time; no value means the token does not expire by date. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by optional minimum-one limit on users or devices permitted by the WiFi integration. greater than or equal to this value.

integer

Filter by optional minimum-one limit on users or devices permitted by the WiFi integration. less than or equal to this value.

integer

Filter by read-only remaining WiFi minutes, initialized from MinutesIncluded when the token is created and reduced by network use. greater than or equal to this value.

integer

Filter by read-only remaining WiFi minutes, initialized from MinutesIncluded when the token is created and reduced by network use. less than or equal to this value.

string

Filter by read-only UTC date and time when the token last accessed the WiFi network. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when the token last accessed the WiFi network. 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/accesstokens?page=1&size=15&orderBy=AccessCode&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by AccessCode

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

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

data = response.json()

Response

200

AccessToken[]

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

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,
      "AccessCode": "",
      "Description": null,
      "MinutesIncluded": 0,
      "ValidFrom": null,
      "ValidTo": null,
      "UserLimit": null,
      "MinutesLeft": 0,
      "MacAddress": null,
      "BookingGuid": null,
      "VisitorGuid": null,
      "LastAccess": 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": "AccessToken Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "AccessCode",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search AccessTokens

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

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

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

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by AccessCode

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by AccessCode

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by AccessCode

Range filters

Response

200