Get one Sensor

GET

api

sys

sensors

{id}

Get one Sensor

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

import requests

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

{
  "BusinessId": 123,
  "Desks": [
    123
  ],
  "Resources": [
    123
  ],
  "CannedResponseId": 123,
  "CannedResponseName": "<string>",
  "Name": "<string>",
  "Reference": "<string>",
  "Unit": "<string>",
  "Active": true,
  "SensorType": 123,
  "DataStrategy": 123,
  "PayloadDataPath": "<string>",
  "ActionTriggerFunction": "<string>",
  "ValueFunction": "<string>",
  "ActionSendEmailAlert": true,
  "AlertEmailAddress": "<string>",
  "WebhookUrl": "<string>",
  "ActionUpdateDeskAvailability": true,
  "ActionUpdateResourceAvailability": true,
  "ActionUpdateBookingOccupancy": true,
  "ActionSendCustomerEmailAlert": true,
  "ActionBookingStart": true,
  "ActionBookingTerminate": true,
  "ActionCheckInOrOut": true,
  "ActionMakeHttpRequest": true,
  "ShowInNowDashboard": true,
  "ShowInPortal": true,
  "SharedSecret": "<string>",
  "ApiKey": "<string>",
  "Username": "<string>",
  "Password": "<string>",
  "ReceivedDataOn": "<string>",
  "LastReceivedValue": "<string>",
  "LastValueTriggeredAction": true,
  "BatteryLevel": 123,
  "NetworkSignalStrength": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A Sensor represents a physical IoT sensor deployed in a location for monitoring environmental conditions or occupancy. Sensors can detect presence, count people, measure temperature, humidity, noise, CO2 levels, and other metrics.

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

Path Parameters

integer

required

The Id of the Sensor record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

integer[]

List of desks linked to this record.

integer[]

List of resources linked to this record.

integer

ID of the canned response linked to this record.

string

Display name of the linked canned response (read-only).

string

The name value for this sensor.

string

The reference value for this sensor.

string

The unit value for this sensor.

boolean

Whether this sensor is currently active.

integer

The sensor type value for this sensor. See eSensorType enum values: 1 = PresenceDetection, 2 = PeopleCounter, 3 = Temperature, 4 = Humidity, 5 = Light, 6 = Noise, 7 = CO2, 8 = VolatileOrganicCompounds, 9 = HarmfulParticulates, 10 = Touch, 11 = Water, 12 = AtmosphericPressure, 13 = Power, 14 = OpenClosed, 99 = Other.

integer

The data strategy value for this sensor. See eSensorDataStrategy enum values: 1 = Polling, 2 = Endpoint, 3 = DisruptiveTechnologies, 4 = Pressac.

string

The payload data path value for this sensor.

string

The action trigger function value for this sensor.

string

The value function value for this sensor.

boolean

Whether action send email alert is enabled.

string

The alert email address value for this sensor.

string

The webhook url value for this sensor.

boolean

Whether action update desk availability is enabled.

boolean

Whether action update resource availability is enabled.

boolean

Whether action update booking occupancy is enabled.

boolean

Whether action send customer email alert is enabled.

boolean

Whether action booking start is enabled.

boolean

Whether action booking terminate is enabled.

boolean

Whether action check in or out is enabled.

boolean

Whether action make http request is enabled.

boolean

Whether show in now dashboard is enabled.

boolean

Whether show in portal is enabled.

string

The shared secret value for this sensor.

string

The api key value for this sensor.

string

The username value for this sensor.

string

The password value for this sensor.

string

Date/time value for received data on.

string

The last received value value for this sensor.

boolean

Whether last value triggered action is enabled.

integer

The battery level value for this sensor.

integer

The network signal strength value for this sensor.

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,
  "Desks": [],
  "Resources": [],
  "CannedResponseId": null,
  "CannedResponseName": null,
  "Name": "",
  "Reference": "",
  "Unit": null,
  "Active": false,
  "SensorType": 0,
  "DataStrategy": 0,
  "PayloadDataPath": null,
  "ActionTriggerFunction": null,
  "ValueFunction": null,
  "ActionSendEmailAlert": false,
  "AlertEmailAddress": null,
  "WebhookUrl": null,
  "ActionUpdateDeskAvailability": false,
  "ActionUpdateResourceAvailability": false,
  "ActionUpdateBookingOccupancy": false,
  "ActionSendCustomerEmailAlert": false,
  "ActionBookingStart": false,
  "ActionBookingTerminate": false,
  "ActionCheckInOrOut": false,
  "ActionMakeHttpRequest": false,
  "ShowInNowDashboard": false,
  "ShowInPortal": false,
  "SharedSecret": null,
  "ApiKey": null,
  "Username": null,
  "Password": null,
  "ReceivedDataOn": null,
  "LastReceivedValue": null,
  "LastValueTriggeredAction": false,
  "BatteryLevel": null,
  "NetworkSignalStrength": 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": "Sensor Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple SensorsRetrieve multiple Sensor records by their Ids in a single request.

Get one Sensor

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

import requests

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

{
  "BusinessId": 123,
  "Desks": [
    123
  ],
  "Resources": [
    123
  ],
  "CannedResponseId": 123,
  "CannedResponseName": "<string>",
  "Name": "<string>",
  "Reference": "<string>",
  "Unit": "<string>",
  "Active": true,
  "SensorType": 123,
  "DataStrategy": 123,
  "PayloadDataPath": "<string>",
  "ActionTriggerFunction": "<string>",
  "ValueFunction": "<string>",
  "ActionSendEmailAlert": true,
  "AlertEmailAddress": "<string>",
  "WebhookUrl": "<string>",
  "ActionUpdateDeskAvailability": true,
  "ActionUpdateResourceAvailability": true,
  "ActionUpdateBookingOccupancy": true,
  "ActionSendCustomerEmailAlert": true,
  "ActionBookingStart": true,
  "ActionBookingTerminate": true,
  "ActionCheckInOrOut": true,
  "ActionMakeHttpRequest": true,
  "ShowInNowDashboard": true,
  "ShowInPortal": true,
  "SharedSecret": "<string>",
  "ApiKey": "<string>",
  "Username": "<string>",
  "Password": "<string>",
  "ReceivedDataOn": "<string>",
  "LastReceivedValue": "<string>",
  "LastValueTriggeredAction": true,
  "BatteryLevel": 123,
  "NetworkSignalStrength": 123,
  "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