List live device rows

Method	Path
GET	/v1/slim/device/live

Authentication · Access policies

Lists live device rows for the dashboard's monitoring views: each device with its resident, location, zone, current telemetry and alerts.

Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs search and read on Patient, Device, Location, Observation and Organization. Scope: the caller's project (from the token).

Behaviour

• By default only devices with a resident assigned are returned. Set includeUnassigned=true to include devices without a resident.
• organizationId takes a zone id, assigned or unassigned. A zone id also matches devices in its child zones.
• deviceId restricts the result to one device, matched against the device identifier.
• effectiveSleepStatus filters on the device's current sleep status.
• search matches resident nickname and name, location name, zone name, and device name, identifier and serial. Matching is fuzzy, plus a substring match on the device fields.
• residentState is accepted but ignored.
• Telemetry is read fresh on every request. The device structure is cached and refreshed when you write through the Slim routes.
• page is zero-based. count defaults to 20, maximum 100.
• For polling only the telemetry and alerts, use GET /v1/slim/device/live/telemetry with the same query.
• The route returns 503 when the server is at capacity for live reads or the device list cannot be built. Retry shortly.

Example

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/device/live?page=0&count=20&sortBy=locationName&orderBy=ASC' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response

200 — One page of live device rows.

Errors

Status	Meaning
401	Bearer token is missing, invalid or expired.
403	You are not a practitioner, admin or System Owner, you lack search or read on Patient, Device, Location, Observation or Organization, your session has no project, or you cannot access the project.
422	A query parameter fails validation.