Search Sensors

GET

api

sys

sensors

Search Sensors

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/sensors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Enums

eSensorType — SensorType values

Value	Name
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

eSensorDataStrategy — DataStrategy values

Value	Name
1	Polling
2	Endpoint
3	DisruptiveTechnologies
4	Pressac

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the required location that owns this sensor..

integer

Filter by iD of the optional email template used by sensor alert actions..

string

Filter by display value for CannedResponse.Name..

string

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

string

Filter by 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

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

boolean

Filter by whether the sensor accepts incoming data and can be polled; inactive sensors do neither..

integer

Filter by 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..

integer

Filter by how readings reach Nexudus: Polling fetches data from PayloadDataPath, while Endpoint, DisruptiveTechnologies, and Pressac receive data through their integrations..

string

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

string

Filter by 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

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

boolean

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

string

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

string

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

boolean

Filter by whether triggering readings update availability for the linked floor plan desks..

boolean

Filter by whether triggering readings update availability for the linked bookable resources..

boolean

Filter by whether triggering readings update occupancy for current bookings on linked resources..

boolean

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

boolean

Filter by whether triggering readings automatically start pending bookings on linked resources..

boolean

Filter by whether triggering readings automatically terminate active bookings on linked resources..

boolean

Filter by whether triggering readings automatically check customers in or out..

boolean

Filter by whether triggering readings send an HTTP request to WebhookUrl..

boolean

Filter by whether the sensor is shown in the Now dashboard for live monitoring..

boolean

Filter by whether this active sensor is included in customer portal and app sensor data..

string

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

string

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

string

Filter by 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

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

string

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

string

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

boolean

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

integer

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

integer

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

Range Filters

string

Filter by read-only UTC date and time when the last valid reading was received; it is set during data ingestion. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when the last valid reading was received; it is set during data ingestion. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only battery level reported by the device when available; it is maintained by sensor data ingestion. greater than or equal to this value.

integer

Filter by read-only battery level reported by the device when available; it is maintained by sensor data ingestion. less than or equal to this value.

integer

Filter by read-only network signal strength reported by the device when available; it is maintained by sensor data ingestion. greater than or equal to this value.

integer

Filter by read-only network signal strength reported by the device when available; it is maintained by sensor data ingestion. less than or equal to this value.

string

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

string

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

string

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

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/sensors?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/sensors',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/sensors?' + new URLSearchParams({
    Sensor_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/sensors',
    params={
        'Sensor_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/sensors?' + new URLSearchParams({
    from_Sensor_UpdatedOn: '2025-01-01T00:00',
    to_Sensor_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/sensors',
    params={
        'from_Sensor_UpdatedOn': '2025-01-01T00:00',
        'to_Sensor_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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
}

Search Sensors

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/sensors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200