> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Sensors

> Search and list Sensor records with filtering, sorting, and pagination.

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

<Note>
  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.
</Note>

## Enums

<Accordion title="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                    |
</Accordion>

<Accordion title="eSensorDataStrategy — DataStrategy values">
  | Value | Name                   |
  | ----- | ---------------------- |
  | 1     | Polling                |
  | 2     | Endpoint               |
  | 3     | DisruptiveTechnologies |
  | 4     | Pressac                |
</Accordion>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="Sensor_Business" type="integer">
  Filter by iD of the business linked to this record.
</ParamField>

<ParamField query="Sensor_CannedResponse" type="integer">
  Filter by iD of the canned response linked to this record.
</ParamField>

<ParamField query="Sensor_CannedResponse_Name" type="string">
  Filter by display name of the linked canned response (read-only).
</ParamField>

<ParamField query="Sensor_Name" type="string">
  Filter by the name value for this sensor.
</ParamField>

<ParamField query="Sensor_Reference" type="string">
  Filter by the reference value for this sensor.
</ParamField>

<ParamField query="Sensor_Unit" type="string">
  Filter by the unit value for this sensor.
</ParamField>

<ParamField query="Sensor_Active" type="boolean">
  Filter by whether this sensor is currently active.
</ParamField>

<ParamField query="Sensor_SensorType" type="integer">
  Filter by the sensor type value for this sensor.
</ParamField>

<ParamField query="Sensor_DataStrategy" type="integer">
  Filter by the data strategy value for this sensor.
</ParamField>

<ParamField query="Sensor_PayloadDataPath" type="string">
  Filter by the payload data path value for this sensor.
</ParamField>

<ParamField query="Sensor_ActionTriggerFunction" type="string">
  Filter by the action trigger function value for this sensor.
</ParamField>

<ParamField query="Sensor_ValueFunction" type="string">
  Filter by the value function value for this sensor.
</ParamField>

<ParamField query="Sensor_ActionSendEmailAlert" type="boolean">
  Filter by whether action send email alert is enabled.
</ParamField>

<ParamField query="Sensor_AlertEmailAddress" type="string">
  Filter by the alert email address value for this sensor.
</ParamField>

<ParamField query="Sensor_WebhookUrl" type="string">
  Filter by the webhook url value for this sensor.
</ParamField>

<ParamField query="Sensor_ActionUpdateDeskAvailability" type="boolean">
  Filter by whether action update desk availability is enabled.
</ParamField>

<ParamField query="Sensor_ActionUpdateResourceAvailability" type="boolean">
  Filter by whether action update resource availability is enabled.
</ParamField>

<ParamField query="Sensor_ActionUpdateBookingOccupancy" type="boolean">
  Filter by whether action update booking occupancy is enabled.
</ParamField>

<ParamField query="Sensor_ActionSendCustomerEmailAlert" type="boolean">
  Filter by whether action send customer email alert is enabled.
</ParamField>

<ParamField query="Sensor_ActionBookingStart" type="boolean">
  Filter by whether action booking start is enabled.
</ParamField>

<ParamField query="Sensor_ActionBookingTerminate" type="boolean">
  Filter by whether action booking terminate is enabled.
</ParamField>

<ParamField query="Sensor_ActionCheckInOrOut" type="boolean">
  Filter by whether action check in or out is enabled.
</ParamField>

<ParamField query="Sensor_ActionMakeHttpRequest" type="boolean">
  Filter by whether action make http request is enabled.
</ParamField>

<ParamField query="Sensor_ShowInNowDashboard" type="boolean">
  Filter by whether show in now dashboard is enabled.
</ParamField>

<ParamField query="Sensor_ShowInPortal" type="boolean">
  Filter by whether show in portal is enabled.
</ParamField>

<ParamField query="Sensor_SharedSecret" type="string">
  Filter by the shared secret value for this sensor.
</ParamField>

<ParamField query="Sensor_ApiKey" type="string">
  Filter by the api key value for this sensor.
</ParamField>

<ParamField query="Sensor_Username" type="string">
  Filter by the username value for this sensor.
</ParamField>

<ParamField query="Sensor_Password" type="string">
  Filter by the password value for this sensor.
</ParamField>

<ParamField query="Sensor_ReceivedDataOn" type="string">
  Filter by date/time value for received data on.
</ParamField>

<ParamField query="Sensor_LastReceivedValue" type="string">
  Filter by the last received value value for this sensor.
</ParamField>

<ParamField query="Sensor_LastValueTriggeredAction" type="boolean">
  Filter by whether last value triggered action is enabled.
</ParamField>

<ParamField query="Sensor_BatteryLevel" type="integer">
  Filter by the battery level value for this sensor.
</ParamField>

<ParamField query="Sensor_NetworkSignalStrength" type="integer">
  Filter by the network signal strength value for this sensor.
</ParamField>

### Range Filters

<ParamField query="from_Sensor_ReceivedDataOn" type="string">
  Filter by date/time value for received data on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Sensor_ReceivedDataOn" type="string">
  Filter by date/time value for received data on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Sensor_BatteryLevel" type="integer">
  Filter by the battery level value for this sensor greater than or equal to this value.
</ParamField>

<ParamField query="to_Sensor_BatteryLevel" type="integer">
  Filter by the battery level value for this sensor less than or equal to this value.
</ParamField>

<ParamField query="from_Sensor_NetworkSignalStrength" type="integer">
  Filter by the network signal strength value for this sensor greater than or equal to this value.
</ParamField>

<ParamField query="to_Sensor_NetworkSignalStrength" type="integer">
  Filter by the network signal strength value for this sensor less than or equal to this value.
</ParamField>

<ParamField query="from_Sensor_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Sensor_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Sensor_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Sensor_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/sensors?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/sensors?Sensor_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Sensor[]">
  The list of Sensor records matching the query. See the [Get one Sensor](/rest-api/sys/get-sensors-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```