Skip to content

Device Filters API

Filter GET /api/devices by name, BLE quality or battery status.


Overview

GET /api/devices now accepts filter parameters so integrators can search or narrow the device list server-side instead of fetching everything and filtering client-side.

Available since: Version 26.01 (March 2026 · API v33)


How to Use

GET /api/devices?name=Door-12&ble-quality=low&battery-status=low
  • name — search devices by (partial) name
  • ble-quality — filter by BLE signal quality
  • battery-status — filter by battery status

Use Cases

  • Building a maintenance dashboard that only lists devices with low battery
  • Quickly locating a device by name in a large installation

Updates

26.01 — March 2026

Initial Release

  • Adds name, ble-quality and battery-status filter parameters to GET /api/devices