Skip to main content
GET
/
api
/
sys
/
sensors
/
{id}
{
  "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>"
}

​
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

​
id
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"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
Desks
integer[]
Desks.
​
Resources
integer[]
Resources.
​
CannedResponseId
integer
Canned Response Id.
​
CannedResponseName
string
Canned Response Name.
​
Name
string
Name.
​
Reference
string
Reference.
​
Unit
string
Unit.
​
Active
boolean
Active.
​
SensorType
integer
Sensor Type.
​
DataStrategy
integer
Data Strategy.
​
PayloadDataPath
string
Payload Data Path.
​
ActionTriggerFunction
string
Action Trigger Function.
​
ValueFunction
string
Value Function.
​
ActionSendEmailAlert
boolean
Action Send Email Alert.
​
AlertEmailAddress
string
Alert Email Address.
​
WebhookUrl
string
Webhook Url.
​
ActionUpdateDeskAvailability
boolean
Action Update Desk Availability.
​
ActionUpdateResourceAvailability
boolean
Action Update Resource Availability.
​
ActionUpdateBookingOccupancy
boolean
Action Update Booking Occupancy.
​
ActionSendCustomerEmailAlert
boolean
Action Send Customer Email Alert.
​
ActionBookingStart
boolean
Action Booking Start.
​
ActionBookingTerminate
boolean
Action Booking Terminate.
​
ActionCheckInOrOut
boolean
Action Check In Or Out.
​
ActionMakeHttpRequest
boolean
Action Make Http Request.
​
ShowInNowDashboard
boolean
Show In Now Dashboard.
​
ShowInPortal
boolean
Show In Portal.
​
SharedSecret
string
Shared Secret.
​
ApiKey
string
Api Key.
​
Username
string
Username.
​
Password
string
Password.
​
ReceivedDataOn
string
Received Data On.
​
LastReceivedValue
string
Last Received Value.
​
LastValueTriggeredAction
boolean
Last Value Triggered Action.
​
BatteryLevel
integer
Battery Level.
​
NetworkSignalStrength
integer
Network Signal Strength.
​
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,
  "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
}