Slim APIs
Reference for Ovok Slim API operations, organized by workflow.
Ovok Slim APIs provide application-ready endpoints for care operations such as patient and device workflows, project structure, alerts, thresholds, and monitoring views. Each operation page is derived from the Ovok implementation and covers its method and path, authentication and access requirements, request behavior, response, and errors.
Use https://api.sandbox.ovok.com for the examples. Send a bearer token unless a route page explicitly says authentication is not required. Most operations apply the project and AccessPolicy in the token; individual pages call out routes with broader or narrower scope. See Authentication and Access policies.
Errors on every route
Each route page lists the errors specific to that route. Any Slim route can also answer with these, and they are not repeated on every page:
| Status | Meaning |
|---|---|
401 | The bearer token is missing, invalid or expired, or an HTTP Basic client secret is wrong. Every 401 includes WWW-Authenticate: Bearer. |
429 | Too many requests. The body has error: "too_many_requests" and retryAfterSec; wait the same number of seconds in Retry-After. The response also has X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (epoch seconds) and X-RateLimit-Retry-After. |
500 | Unexpected server error. Retry; if it persists, contact Ovok support. |
503 | Your access policy cannot be read right now, or the service is briefly over capacity. Retry shortly. When the response has a Retry-After header, wait that many seconds first. |
Browsers cannot read WWW-Authenticate or the X-RateLimit-* headers; only Retry-After is CORS-exposed.
Compression. JSON answers of 1 KB or more are gzip or Brotli when Accept-Encoding requests it. The response includes Content-Encoding and Vary: Accept-Encoding; do not rely on Content-Length. Streamed text/plain and text/event-stream answers, HEAD responses and Accept-Encoding: identity are not compressed. Decompressed bodies are unchanged. These rules apply to every Ovok API route.
Browse by route group
Patients
POST /v1/slim/patient/check-name-exists— Check patient name existsPOST /v1/slim/patient— Create patientDELETE /v1/slim/patient/:id— Delete patientGET /v1/slim/patient/:id— Get patientGET /v1/slim/patient/:id/$everything— Get patient $everythingGET /v1/slim/patient/:id/current-vitals— Get patient current vitalsGET /v1/slim/patient— List patientsPUT /v1/slim/patient/:id— Update patient
Devices
POST /v1/slim/device— Create deviceDELETE /v1/slim/device/:id— Delete deviceGET /v1/slim/device/:id— Get deviceGET /v1/slim/device— List devicesGET /v1/slim/device/live— List live device rowsGET /v1/slim/device/live/telemetry— List live telemetry and alerts by deviceGET /v1/slim/device/assign/project— List projects for device assignmentPUT /v1/slim/device/assign/project— Move device to another projectPOST /v1/slim/device/routing— Resolve how ingest routes device serialsPUT /v1/slim/device/:id— Update device
Locations
POST /v1/slim/location— Create locationPOST /v1/slim/location/admin— Create location in a project (admin)DELETE /v1/slim/location/:id— Delete locationGET /v1/slim/location/:id— Get locationGET /v1/slim/location/assignment-candidates— List location assignment candidatesGET /v1/slim/location— List locationsGET /v1/slim/location/admin/list— List locations in a project (admin)PUT /v1/slim/location/:id— Update location
Zones
POST /v1/slim/zones/:zoneId/locations— Create location in zoneDELETE /v1/slim/zones/:zoneId/locations/:locationId— Delete location in zoneGET /v1/slim/zones/:zoneId— Get zone detailGET /v1/slim/zones/device-counts— Get zone device countsGET /v1/slim/zones— List zonesPUT /v1/slim/zones/:zoneId/locations/:locationId— Update location in zone
Organizations
POST /v1/slim/organization— Create organizationDELETE /v1/slim/organization/:id— Delete organizationGET /v1/slim/organization/:id— Get organizationPUT /v1/slim/organization/:id— Update organization
Projects
POST /v1/slim/project/child— Create a child projectDELETE /v1/slim/project/child/:subProjectId— Delete a child projectGET /v1/slim/project/:id— Get a projectGET /v1/slim/project/:id/device-counts— Get project device countsGET /v1/slim/project/:id/patient-counts— Get project patient countsGET /v1/slim/project/child— List child project relationshipsGET /v2/slim/project/child— List child projects with device countsGET /v1/slim/project/users— List current project usersGET /v1/slim/project/:id/users— List project usersPUT /v1/slim/project/:id— Update a project
Access policies
POST /v1/slim/policy— Create access policyDELETE /v1/slim/policy/:id— Delete access policyGET /v1/slim/policy/:id— Get access policyGET /v1/slim/policy— List access policiesPUT /v1/slim/policy/:id— Update access policy
Practitioners
GET /v1/slim/practitioner/:id— Get practitionerPUT /v1/slim/practitioner/:id— Update practitioner
Invitations
Notifications
GET /v1/slim/notifications/medical/:episodeId/notes— A medical notification's notesGET /v1/slim/notifications/raw-alerts/:alertId/notes— A raw Signals alert's notesPOST /v1/slim/notifications/medical/:episodeId/ack— Acknowledge medical notificationPATCH /v1/slim/notifications/:id/ack— Acknowledge notificationGET /v1/slim/notifications/alarms/:id/notes— An alarm notification's notesGET /v1/slim/notifications/oob/:id/notes— An out-of-bed notification's notesDELETE /v1/slim/notifications/notes/:noteId— Delete a notePATCH /v1/slim/notifications/notes/:noteId— Edit a note's textGET /v1/slim/notifications/medical/:episodeId— Get medical notificationPOST /v1/slim/notifications/notes— Leave a note on a notificationGET /v1/slim/notifications/alarms— List alarm notificationsGET /v1/slim/notifications/medical— List medical notificationsGET /v1/slim/notifications/oob— List out-of-bed notificationsGET /v1/slim/notifications/recent/alarms— List recent alarm notificationsGET /v1/slim/notifications/recent/medical— List recent medical notificationsGET /v1/slim/notifications/recent— List recent notificationsGET /v1/slim/notifications/recent/oob— List recent out-of-bed notificationsPUT /v1/slim/notifications/notes/:noteId— Replace a note's text
Thresholds
GET /v2/slim/threshold— Get current org threshold (v2)GET /v1/slim/threshold— Get current thresholdGET /v1/slim/threshold/patient/:patientId— Get patient effective thresholdGET /v2/slim/threshold/patient/:patientId— Get patient effective threshold (v2)GET /v1/slim/threshold/patient/:patientId/vitals— Get patient vital thresholdsDELETE /v1/slim/threshold/patient/:patientId/vitals/:code— Remove a patient vital thresholdPUT /v1/slim/threshold/patient/:patientId/vitals/:code— Set a patient vital thresholdPUT /v2/slim/threshold— Update org threshold (v2)PUT /v1/slim/threshold/patient/:patientId— Update patient thresholdPUT /v2/slim/threshold/patient/:patientId— Update patient threshold (v2)PUT /v1/slim/threshold— Update threshold
Telemetry
GET /v1/slim/telemetry/:deviceId— Get device telemetry and alertsGET /v1/slim/telemetry/:deviceId/effectiveIds— Get effective observation ids for a deviceGET /v1/slim/telemetry/:deviceId/lastIds— Get last-received observation ids for a deviceGET /v1/slim/telemetry/effectiveIds— List effective observation ids by deviceGET /v1/slim/telemetry/lastIds— List last-received observation ids by device
Trends
GET /v1/slim/trends/realtime— Get realtime trends graphsGET /v1/slim/trends/graphs— Get trends graphs
Sleep
Reports and exports
Users
DELETE /v1/slim/user/:profileType/:profileId— Delete userGET /v1/slim/user/consents— Get all user consentsGET /v1/slim/user/medical-settings-notifications-consent— Get medical settings notifications consent (deprecated)GET /v1/slim/user/terms-and-conditions-consent— Get terms and conditions consentPOST /v1/slim/user/support— Send support messagePOST /v1/slim/user/medical-settings-notifications-consent— Update medical settings notifications consent (deprecated)POST /v1/slim/user/terms-and-conditions-consent— Update terms and conditions consentPOST /v1/slim/user/consents— Update user consents
Audit
Last updated on