Devices
List devices
List devices using Ovok’s Slim API.
| Method | Path |
|---|---|
GET | /v1/slim/device |
Authentication · Access policies
Lists the devices in your project with their zone, location and resident names. Use it for device directory and administration screens.
Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:search and Device:read.
Scope: the caller's project (from the token).
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Zero-based page number. Default 0, minimum 0. |
count | integer | No | Rows per page. Default 20, minimum 1, maximum 100. |
sortBy | "deviceName" | "locationName" | "patientName" | "organizationName" | "lastActivityTime" | "createdAt" | No | Sort column. Default deviceName. |
orderBy | "ASC" | "DESC" | No | Sort direction. Upper case only. Default ASC. |
search | string | No | Case-insensitive substring match on device name, location name and zone name. Trimmed, at least 1 character. |
patientSearch | string | No | Case-insensitive substring match on resident name. Trimmed, at least 1 character. |
organizationId | string | No | Keep devices in this zone. |
locationId | string | No | Keep devices in this location. |
patientId | string | No | Keep the device of this resident. |
active | boolean | No | true keeps active devices. Any other value keeps inactive devices. Omit to keep both. |
Behaviour
- Every device in the project is listed, whether or not it has a location or resident.
idis the Device resource id.thingsboardIdis the device identifier that telemetry is keyed by.statusisactivewhen the device's live telemetry reports it active, otherwiseinactive.lastActivityTimeis the latest telemetry activity time, or the device's last-seen time when telemetry has none.searchmatches device, location and zone names.patientSearchmatches resident names. Both are case-insensitive substring matches.organizationId,locationId,patientIdandactivefilter on exact values.- Rows with an empty sort value sort last in
ASCorder and first inDESCorder. pageis zero-based.countdefaults to 20, maximum 100.totalis the number of rows after filtering.- The device structure is cached for up to 5 minutes. Writes made through the Slim routes refresh it sooner.
- If the device list cannot be built and no earlier complete list exists, the route returns 503. Retry shortly.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/device?page=0&count=20&sortBy=deviceName&orderBy=ASC' \
-H "Authorization: Bearer ${OVOK_TOKEN}"Successful response
200 — One page of devices.
{
"total": 1,
"page": 0,
"count": 20,
"resources": [
{
"id": "8c5e7a21-4b9d-4f36-a1c8-0d2e6b9f3a54",
"name": "Demo/1000001",
"thingsboardId": "Demo/1000001",
"status": "active",
"organizationId": "1e6b8d30-2c4f-4a95-8d7e-b0a2c4e6f918",
"organizationName": "Zone A",
"locationId": "5d2a9c64-7e1b-4830-b6f5-9a3c1e8d7b02",
"locationName": "Room 101 Bed 1",
"patientId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21",
"patientName": "demo-resident",
"lastActivityTime": "2026-10-09T08:53:20.000Z",
"createdAt": "2026-09-01T07:30:00.000Z"
}
]
}| Field | Type | Description |
|---|---|---|
total | integer | Number of rows after filtering, across all pages. |
page | integer | Page number of this response. |
count | integer | Page size of this response. |
resources | object[] | The devices of this page. |
resources[].id | string (uuid) | Device id. |
resources[].name | string | Device name. |
resources[].thingsboardId | string | Device identifier that telemetry is keyed by. |
resources[].status | "active" | "inactive" | active when the device's live telemetry reports it active. |
resources[].organizationId | string | null | Zone id. |
resources[].organizationName | string | null | Zone name. |
resources[].locationId | string | null | Location id. |
resources[].locationName | string | null | Location name. |
resources[].patientId | string | null | Resident on the device. |
resources[].patientName | string | null | The resident's full display name. |
resources[].lastActivityTime | string | null | Latest telemetry activity time, or the device's last-seen time when telemetry has none. ISO 8601. |
resources[].createdAt | string | null | When the device record was last changed, as an ISO 8601 time string. |
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack Device:search or Device:read, your session has no project, or you cannot access the project. |
422 | A query parameter fails validation. |
503 | The device list cannot be built and no earlier complete list exists. Retry shortly. |
Last updated on