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>'

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 is an IoT device for a location that receives or polls environmental and occupancy readings, and can use changed readings to update availability, manage bookings, and send alerts.

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 required location that owns this sensor..

integer[]

List of floor plan desks whose occupancy and latest sensor value this sensor can update; an empty list means no desks are affected..

integer[]

List of bookable resources whose availability, occupancy, and latest sensor value this sensor can update; an empty list means no resources are affected..

integer

ID of the optional email template used by sensor alert actions..

string

Display value for CannedResponse.Name..

string

Required non-empty display name for the sensor; together with Unit it identifies the sensor within the location..

string

Required unique integration reference used to find this sensor within its location; set it when creating the sensor and do not change it later..

string

Optional unit label for the sensor reading, such as C, percent, or people; together with Name it identifies the sensor within the location..

boolean

Whether the sensor accepts incoming data and can be polled; inactive sensors do neither..

integer

Kind of reading produced by the device: PresenceDetection, PeopleCounter, Temperature, Humidity, Light, Noise, CO2, VolatileOrganicCompounds, HarmfulParticulates, Touch, Water, AtmosphericPressure, Power, OpenClosed, or Other; presence values are normalized to 0 or 1.. 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

How readings reach Nexudus: Polling fetches data from PayloadDataPath, while Endpoint, DisruptiveTechnologies, and Pressac receive data through their integrations.. See eSensorDataStrategy enum values: 1 = Polling, 2 = Endpoint, 3 = DisruptiveTechnologies, 4 = Pressac.

string

URL fetched for a Polling sensor to obtain its payload; polling does nothing when this value is empty..

string

Optional Flee expression that decides whether a changed reading runs enabled actions; leave empty to run actions for every changed reading, and use payload and sensor as the available context variables..

string

Optional Flee expression that extracts the sensor reading from the incoming payload; leave empty to use payload[“value”]..

boolean

Whether a changed reading that triggers actions sends an operator email alert; repeated alerts are suppressed until a non-triggering reading occurs..

string

Optional email address that receives operator sensor alerts when ActionSendEmailAlert is enabled; must be a valid email address..

string

Optional destination URL used by the HTTP request action; it is also logged as the polling source for diagnostics..

boolean

Whether triggering readings update availability for the linked floor plan desks..

boolean

Whether triggering readings update availability for the linked bookable resources..

boolean

Whether triggering readings update occupancy for current bookings on linked resources..

boolean

Whether a changed reading that triggers actions sends a customer alert email; repeated alerts are suppressed until a non-triggering reading occurs..

boolean

Whether triggering readings automatically start pending bookings on linked resources..

boolean

Whether triggering readings automatically terminate active bookings on linked resources..

boolean

Whether triggering readings automatically check customers in or out..

boolean

Whether triggering readings send an HTTP request to WebhookUrl..

boolean

Whether the sensor is shown in the Now dashboard for live monitoring..

boolean

Whether this active sensor is included in customer portal and app sensor data..

string

Encrypted shared secret used to validate incoming webhook signatures; configure it through a secure integration workflow, not the Admin Agent..

string

Encrypted API credential used to authenticate sensor polling or incoming requests; configure it through a secure integration workflow, not the Admin Agent..

string

Username paired with the encrypted Password for HTTP Basic authentication; it is not usable through the Admin Agent because the paired password is protected..

string

Encrypted password paired with Username for HTTP Basic authentication; configure it through a secure integration workflow, not the Admin Agent..

string

Read-only UTC date and time when the last valid reading was received; it is set during data ingestion..

string

Read-only most recent valid reading after ValueFunction processing; change the device payload or ValueFunction instead..

boolean

Whether the most recent changed reading passed ActionTriggerFunction and ran enabled actions; it is set during data ingestion..

integer

Read-only battery level reported by the device when available; it is maintained by sensor data ingestion..

integer

Read-only network signal strength reported by the device when available; it is maintained by sensor data ingestion..

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 one Sensor

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

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