Skip to main content
GET
/
api
/
spaces
/
accesstokens
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
WiFi Access Tokens provide unique network access codes for customers and visitors. They work alongside the Mikrotik, IronWifi, and Layer8 integrations. Access tokens can be shared with customers and visitors as part of visitor and booking confirmation emails. Each token includes a number of minutes of WiFi access and, optionally, an expiration date and 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

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
AccessToken_Business
integer
Filter by Business Id.
​
AccessToken_AccessCode
string
Filter by unique network access code used to connect to WiFi.
​
AccessToken_Description
string
Filter by free-text description of this access token.
​
AccessToken_MinutesIncluded
integer
Filter by total minutes of WiFi access included in this token.
​
AccessToken_ValidFrom
string
Filter by start date from which this token can be used.
​
AccessToken_ValidTo
string
Filter by expiration date after which this token is no longer valid.
​
AccessToken_UserLimit
integer
Filter by maximum number of users that can use this token simultaneously.
​
AccessToken_MinutesLeft
integer
Filter by remaining minutes of WiFi access available on this token.
​
AccessToken_MacAddress
string
Filter by mAC address of the device associated with this token.
​
AccessToken_BookingGuid
string
Filter by Booking Guid.
​
AccessToken_VisitorGuid
string
Filter by Visitor Guid.
​
AccessToken_LastAccess
string
Filter by date and time this token was last used to connect.

​
Range Filters

​
from_AccessToken_MinutesIncluded
integer
Filter by total minutes of WiFi access included in this token greater than or equal to this value.
​
to_AccessToken_MinutesIncluded
integer
Filter by total minutes of WiFi access included in this token less than or equal to this value.
​
from_AccessToken_ValidFrom
string
Filter by start date from which this token can be used greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_AccessToken_ValidFrom
string
Filter by start date from which this token can be used less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_AccessToken_ValidTo
string
Filter by expiration date after which this token is no longer valid greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_AccessToken_ValidTo
string
Filter by expiration date after which this token is no longer valid less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_AccessToken_UserLimit
integer
Filter by maximum number of users that can use this token simultaneously greater than or equal to this value.
​
to_AccessToken_UserLimit
integer
Filter by maximum number of users that can use this token simultaneously less than or equal to this value.
​
from_AccessToken_MinutesLeft
integer
Filter by remaining minutes of WiFi access available on this token greater than or equal to this value.
​
to_AccessToken_MinutesLeft
integer
Filter by remaining minutes of WiFi access available on this token less than or equal to this value.
​
from_AccessToken_LastAccess
string
Filter by date and time this token was last used to connect greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_AccessToken_LastAccess
string
Filter by date and time this token was last used to connect less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_AccessToken_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_AccessToken_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_AccessToken_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_AccessToken_UpdatedOn
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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by AccessCode

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

​
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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
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.
Partial records — The listing endpoint returns a summary representation of each AccessToken. The following fields are not included in the Records[] response: MinutesIncluded, ValidTo, UserLimit.To get all fields, fetch the full record using the Get one AccessToken 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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
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
}