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:

StatusMeaning
401The bearer token is missing, invalid or expired, or an HTTP Basic client secret is wrong. Every 401 includes WWW-Authenticate: Bearer.
429Too 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.
500Unexpected server error. Retry; if it persists, contact Ovok support.
503Your 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

Devices

Locations

Zones

Organizations

Projects

Access policies

Practitioners

Invitations

Notifications

Thresholds

Telemetry

Sleep

Reports and exports

Users

Audit

Last updated on

On this page