Get one AccessToken

GET

api

spaces

accesstokens

{id}

Get one AccessToken

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

import requests

url = "https://spaces.nexudus.com/api/spaces/accesstokens/{id}"

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/accesstokens/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/accesstokens/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/accesstokens/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Unique network access code used to connect to WiFi.

string

Free-text description of this access token.

integer

Total minutes of WiFi access included in this token.

string

Start date from which this token can be used.

string

Expiration date after which this token is no longer valid.

integer

Maximum number of users that can use this token simultaneously.

integer

Remaining minutes of WiFi access available on this token.

string

MAC address of the device associated with this token.

string

Unique identifier (GUID) for the booking.

string

Unique identifier (GUID) for the visitor.

string

Date and time this token was last used to connect.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple AccessTokensRetrieve multiple AccessToken records by their Ids in a single request.

Get one AccessToken

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

import requests

url = "https://spaces.nexudus.com/api/spaces/accesstokens/{id}"

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/accesstokens/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200