Thresholds
Get current threshold
Get current threshold using Ovok’s Slim API.
| Method | Path |
|---|---|
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).
Request
No parameters.
Behaviour
- Read-only.
- A home that has never saved thresholds gets the default template: heart rate is enabled at 40–110 bpm, respiratory rate is enabled at 8–25 breaths/min, and every other metric (including out of bed) is disabled. It has no
id, anddateis the time of the request. - If the stored thresholds cannot be read, the route answers 502, never the default template.
- Units:
durationOfOutOfBedis in seconds,sleepDurationin hours. - The home's limit ranges are only on Get current org threshold (v2); this route never returns them. The optional vitals (SpO₂, pulse rate, perfusion index, body temperature) are returned here, as stored, when the home watches them, but only v2 can set them.
- 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.
{
"id": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b31",
"projectId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b11",
"status": "active",
"date": "2026-10-09T08:30:00.000Z",
"settings": {
"heartRate": { "mode": "organization", "enabled": true, "absolute": { "enabled": true, "min": 40, "max": 110 } },
"meanHeartRate": { "mode": "organization", "enabled": false, "relative": { "enabled": false, "min": 0, "max": 0 } },
"respiratoryRate": { "mode": "organization", "enabled": true, "absolute": { "enabled": true, "min": 8, "max": 25 } },
"meanRespiratoryRate": { "mode": "organization", "enabled": false, "relative": { "enabled": false, "min": 0, "max": 0 } },
"durationOfOutOfBed": {
"mode": "organization",
"enabled": true,
"period": { "mode": "organization", "start": "19:00:00", "end": "09:00:00", "timezone": null },
"absolute": { "enabled": true, "max": 600 }
},
"sleepDuration": { "mode": "organization", "enabled": true, "absolute": { "enabled": true, "min": 7, "max": 10 } },
"numberOfTimesGettingOutOfBed": { "mode": "organization", "enabled": true, "absolute": { "enabled": true, "max": 0 } }
}
}| Field | Type | Description |
|---|---|---|
id | string | The id of the stored threshold document. Omitted for a home with nothing stored. |
projectId | string | The caller's project. |
status | "active" | The state of the threshold document. Reads return the active one. |
date | string (ISO 8601 date-time) | When the home's thresholds were last saved. For a home with nothing stored, the time of the request. |
settings | object | The home's limits per metric. A metric the home has not stored is omitted. |
settings.heartRate | object | Heart-rate limit. |
settings.heartRate.mode | "organization" | Always organization: these are the home's limits. |
settings.heartRate.enabled | boolean | Whether the metric alerts. |
settings.heartRate.absolute | object | The fixed band. |
settings.heartRate.absolute.enabled | boolean | Whether the fixed band is armed. |
settings.heartRate.absolute.min | number | Lower bound in beats per minute. Omitted when none is stored. |
settings.heartRate.absolute.max | number | Upper bound in beats per minute. Omitted when none is stored. |
settings.respiratoryRate | object | Respiratory-rate limit. Same fields as settings.heartRate, in breaths per minute. |
settings.meanHeartRate | object | Baseline (mean) heart-rate band. A home cannot arm one, so it reads off unless an older save left it on. |
settings.meanHeartRate.mode | "organization" | Always organization. |
settings.meanHeartRate.enabled | boolean | Whether the metric alerts. |
settings.meanHeartRate.relative | object | The band as multipliers of the resident's baseline (for example 0.8 and 1.2). |
settings.meanHeartRate.relative.enabled | boolean | Whether the relative band is armed. |
settings.meanHeartRate.relative.min | number | Lower multiplier. Omitted when none is stored. |
settings.meanHeartRate.relative.max | number | Upper multiplier. Omitted when none is stored. |
settings.meanRespiratoryRate | object | Baseline (mean) respiratory-rate band. Same fields as settings.meanHeartRate. |
settings.durationOfOutOfBed | object | Out-of-bed limit. |
settings.durationOfOutOfBed.mode | "organization" | Always organization. |
settings.durationOfOutOfBed.enabled | boolean | Whether the metric alerts. |
settings.durationOfOutOfBed.period | object | The window in which out-of-bed is checked. Omitted when none is stored; the default template carries 19:00 to 09:00 even though out-of-bed is disabled. |
settings.durationOfOutOfBed.period.mode | "organization" | Present on a stored document; absent in the default template. |
settings.durationOfOutOfBed.period.start | string (HH:MM:SS) | Window start. |
settings.durationOfOutOfBed.period.end | string (HH:MM:SS) | null | Window end. Equal to start means 24 hours; before start crosses midnight. |
settings.durationOfOutOfBed.period.timezone | string | null | Time zone stored with the window, or null. Absent in the default template. |
settings.durationOfOutOfBed.absolute | object | The longest exit allowed. |
settings.durationOfOutOfBed.absolute.enabled | boolean | Whether the limit is armed. |
settings.durationOfOutOfBed.absolute.max | number | The longest exit allowed, in seconds. |
settings.durationOfOutOfBed.relative | object | The relative band, when one is stored: { enabled, min, max }, with min 1 and max 1 + p/100 for a band of p percent. Omitted when none is stored. |
settings.sleepDuration | object | Sleep-duration limit. |
settings.sleepDuration.mode | "organization" | Always organization. |
settings.sleepDuration.enabled | boolean | Whether the metric alerts. |
settings.sleepDuration.absolute | object | { enabled, min, max } in hours. min and max are number, omitted when none is stored. |
settings.numberOfTimesGettingOutOfBed | object | Out-of-bed count limit. |
settings.numberOfTimesGettingOutOfBed.mode | "organization" | Always organization. |
settings.numberOfTimesGettingOutOfBed.enabled | boolean | Whether the metric alerts. |
settings.numberOfTimesGettingOutOfBed.absolute | object | { enabled, max }. max is a number, omitted when none is stored. |
settings.oxygenSaturation | object | Optional vital, present only when the home watches it: { mode, enabled, absolute }. mode is organization; absolute is { enabled, min, max } with min and max omitted for an open side. |
settings.pulseRate | object | Optional vital. Same fields as settings.oxygenSaturation. |
settings.perfusionIndex | object | Optional vital. Same fields as settings.oxygenSaturation. |
settings.bodyTemperature | object | Optional vital. Same fields as settings.oxygenSaturation. |
Errors
Last updated on