Search Sensors

GET

api

sys

sensors

Search Sensors

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

import requests

url = "https://spaces.nexudus.com/api/sys/sensors"

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', 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 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-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 business linked to this record.

integer

Filter by iD of the canned response linked to this record.

string

Filter by display name of the linked canned response (read-only).

string

Filter by the name value for this sensor.

string

Filter by the reference value for this sensor.

string

Filter by the unit value for this sensor.

boolean

Filter by whether this sensor is currently active.

integer

Filter by the sensor type value for this sensor.

integer

Filter by the data strategy value for this sensor.

string

Filter by the payload data path value for this sensor.

string

Filter by the action trigger function value for this sensor.

string

Filter by the value function value for this sensor.

boolean

Filter by whether action send email alert is enabled.

string

Filter by the alert email address value for this sensor.

string

Filter by the webhook url value for this sensor.

boolean

Filter by whether action update desk availability is enabled.

boolean

Filter by whether action update resource availability is enabled.

boolean

Filter by whether action update booking occupancy is enabled.

boolean

Filter by whether action send customer email alert is enabled.

boolean

Filter by whether action booking start is enabled.

boolean

Filter by whether action booking terminate is enabled.

boolean

Filter by whether action check in or out is enabled.

boolean

Filter by whether action make http request is enabled.

boolean

Filter by whether show in now dashboard is enabled.

boolean

Filter by whether show in portal is enabled.

string

Filter by the shared secret value for this sensor.

string

Filter by the api key value for this sensor.

string

Filter by the username value for this sensor.

string

Filter by the password value for this sensor.

string

Filter by date/time value for received data on.

string

Filter by the last received value value for this sensor.

boolean

Filter by whether last value triggered action is enabled.

integer

Filter by the battery level value for this sensor.

integer

Filter by the network signal strength value for this sensor.

Range Filters

string

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

string

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

integer

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

integer

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

integer

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

integer

Filter by the network signal strength value for this sensor 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
}

Get one SensorRetrieve a single Sensor record by its Id.

Search Sensors

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

import requests

url = "https://spaces.nexudus.com/api/sys/sensors"

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