Get one RegisteredDevice

GET

api

sys

registereddevices

{id}

Get one RegisteredDevice

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

import requests

url = "https://spaces.nexudus.com/api/sys/registereddevices/{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/sys/registereddevices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "UserId": 123,
  "Name": "<string>",
  "DeviceType": "<string>",
  "DeviceId": "<string>",
  "ConfigurationData": "<string>",
  "Active": true,
  "LastHeartBeat": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A registered device is an integration hardware or software client associated with a location; operators can identify it, review its status, and enable or disable it.

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 RegisteredDevice-Read role.

Path Parameters

integer

required

The Id of the RegisteredDevice record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location the device is associated with; association is managed by the device association workflow..

integer

ID of the internal user account provisioned for the associated device; managed by the device association workflow and not available for agent use..

string

Required operator-facing name used to identify the registered device..

string

Read-only device type assigned during registration; it determines the device’s authentication and permission behavior..

string

Read-only unique identifier supplied by the device during registration and used for device authentication and messaging..

string

Internal JSON configuration returned directly to the device; integration-specific and not available for agent use..

boolean

Whether the device can authenticate, associate with a location, send heartbeats, and submit logs; inactive devices cannot perform these operations..

string

Read-only UTC date and time of the most recent device registration, heartbeat, or log submission..

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": null,
  "UserId": null,
  "Name": "",
  "DeviceType": "",
  "DeviceId": "",
  "ConfigurationData": null,
  "Active": false,
  "LastHeartBeat": 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": "RegisteredDevice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one RegisteredDevice

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

import requests

url = "https://spaces.nexudus.com/api/sys/registereddevices/{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/sys/registereddevices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "UserId": 123,
  "Name": "<string>",
  "DeviceType": "<string>",
  "DeviceId": "<string>",
  "ConfigurationData": "<string>",
  "Active": true,
  "LastHeartBeat": "<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