Skip to main content
GET
/
api
/
spaces
/
accesstokens
/
{id}
{
  "BusinessId": 123,
  "AccessCode": "<string>",
  "Description": "<string>",
  "MinutesIncluded": 123,
  "ValidFrom": "<string>",
  "ValidTo": "<string>",
  "UserLimit": 123,
  "MinutesLeft": 123,
  "MacAddress": "<string>",
  "BookingGuid": "<string>",
  "VisitorGuid": "<string>",
  "LastAccess": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the AccessToken record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
Business Id.
​
AccessCode
string
Unique network access code used to connect to WiFi.
​
Description
string
Free-text description of this access token.
​
MinutesIncluded
integer
Total minutes of WiFi access included in this token.
​
ValidFrom
string
Start date from which this token can be used.
​
ValidTo
string
Expiration date after which this token is no longer valid.
​
UserLimit
integer
Maximum number of users that can use this token simultaneously.
​
MinutesLeft
integer
Remaining minutes of WiFi access available on this token.
​
MacAddress
string
MAC address of the device associated with this token.
​
BookingGuid
string
Booking Guid.
​
VisitorGuid
string
Visitor Guid.
​
LastAccess
string
Date and time this token was last used to connect.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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
}