Search Sensors

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-List role.

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 1 for ascending, -1 for descending.

Filters

Sensor_Business

integer

Filter by Business Id.

Sensor_CannedResponse

integer

Filter by Canned Response Id.

Sensor_CannedResponse_Name

string

Filter by Canned Response Name.

Sensor_Name

string

Filter by Name.

Sensor_Reference

string

Filter by Reference.

Sensor_Unit

string

Filter by Unit.

Sensor_Active

boolean

Filter by Active.

Sensor_SensorType

integer

Filter by Sensor Type.

Sensor_DataStrategy

integer

Filter by Data Strategy.

Sensor_PayloadDataPath

string

Filter by Payload Data Path.

Sensor_ActionTriggerFunction

string

Filter by Action Trigger Function.

Sensor_ValueFunction

string

Filter by Value Function.

Sensor_ActionSendEmailAlert

boolean

Filter by Action Send Email Alert.

Sensor_AlertEmailAddress

string

Filter by Alert Email Address.

Sensor_WebhookUrl

string

Filter by Webhook Url.

Sensor_ActionUpdateDeskAvailability

boolean

Filter by Action Update Desk Availability.

Sensor_ActionUpdateResourceAvailability

boolean

Filter by Action Update Resource Availability.

Sensor_ActionUpdateBookingOccupancy

boolean

Filter by Action Update Booking Occupancy.

Sensor_ActionSendCustomerEmailAlert

boolean

Filter by Action Send Customer Email Alert.

Sensor_ActionBookingStart

boolean

Filter by Action Booking Start.

Sensor_ActionBookingTerminate

boolean

Filter by Action Booking Terminate.

Sensor_ActionCheckInOrOut

boolean

Filter by Action Check In Or Out.

Sensor_ActionMakeHttpRequest

boolean

Filter by Action Make Http Request.

Sensor_ShowInNowDashboard

boolean

Filter by Show In Now Dashboard.

Sensor_ShowInPortal

boolean

Filter by Show In Portal.

Sensor_SharedSecret

string

Filter by Shared Secret.

Sensor_ApiKey

string

Filter by Api Key.

Sensor_Username

string

Filter by Username.

Sensor_Password

string

Filter by Password.

Sensor_ReceivedDataOn

string

Filter by Received Data On.

Sensor_LastReceivedValue

string

Filter by Last Received Value.

Sensor_LastValueTriggeredAction

boolean

Filter by Last Value Triggered Action.

Sensor_BatteryLevel

integer

Filter by Battery Level.

Sensor_NetworkSignalStrength

integer

Filter by Network Signal Strength.

Range Filters

from_Sensor_ReceivedDataOn

string

Filter by received data on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Sensor_ReceivedDataOn

string

Filter by received data on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Sensor_BatteryLevel

integer

Filter by battery level greater than or equal to this value.

to_Sensor_BatteryLevel

integer

Filter by battery level less than or equal to this value.

from_Sensor_NetworkSignalStrength

integer

Filter by network signal strength greater than or equal to this value.

to_Sensor_NetworkSignalStrength

integer

Filter by network signal strength less than or equal to this value.

from_Sensor_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Sensor_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_Sensor_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_Sensor_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/sensors?page=1&size=15&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/sensors?Sensor_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/sensors?from_Sensor_UpdatedOn=2025-01-01T00:00&to_Sensor_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

Sensor[]

The list of Sensor records matching the query. See the Get one Sensor endpoint for the full list of properties returned for each record.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (1 = ascending, -1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200