Skip to main content

Get current threshold

MethodPath
GET/v1/slim/threshold

Authentication · Access policies

Returns the home's threshold configuration: the alert limits every resident follows unless they have limits of their own.

Deprecated. Use GET /v2/slim/threshold. This v1 route stays available, unchanged, until every client has moved.

Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant PlanDefinition:read (admins and super admins skip this check). Scope: The caller's project (from the token).

Behaviour​

  • Read-only.
  • A home that has never saved thresholds gets an empty template with every metric disabled.
  • If the stored thresholds cannot be read, the route answers 502, never the empty template.
  • Units: durationOfOutOfBed is in seconds, sleepDuration in hours.
  • The home's limit ranges and the optional vitals (SpO₂, pulse rate, perfusion index, body temperature) are only on the v2 route.
  • Heart-rate and respiratory-rate limits are evaluated by Signals. Ovok stores them and forwards them to Signals.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/threshold' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Current threshold retrieved successfully.

Errors​

StatusMeaning
400Your session has no project.
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, or you lack PlanDefinition:read.
502The home's stored thresholds could not be read.