# Slim APIs

Canonical page: https://docs.ovok.com/slim-apis

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](/authentication) and [Access policies](/access-policies).

## Errors on every route [#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 [#browse-by-route-group]

### Patients [#patients]

- [`POST /v1/slim/patient/check-name-exists` — Check patient name exists](/slim-apis/patient/check-patient-name-exists)
- [`POST /v1/slim/patient` — Create patient](/slim-apis/patient/create-patient)
- [`DELETE /v1/slim/patient/:id` — Delete patient](/slim-apis/patient/delete-patient)
- [`GET /v1/slim/patient/:id` — Get patient](/slim-apis/patient/get-patient)
- [`GET /v1/slim/patient/:id/$everything` — Get patient $everything](/slim-apis/patient/get-patient-everything)
- [`GET /v1/slim/patient/:id/current-vitals` — Get patient current vitals](/slim-apis/patient/get-patient-current-vitals)
- [`GET /v1/slim/patient` — List patients](/slim-apis/patient/list-patients)
- [`PUT /v1/slim/patient/:id` — Update patient](/slim-apis/patient/update-patient)

### Devices [#devices]

- [`POST /v1/slim/device` — Create device](/slim-apis/device/create-device)
- [`DELETE /v1/slim/device/:id` — Delete device](/slim-apis/device/delete-device)
- [`GET /v1/slim/device/:id` — Get device](/slim-apis/device/get-device)
- [`GET /v1/slim/device` — List devices](/slim-apis/device/list-devices)
- [`GET /v1/slim/device/live` — List live device rows](/slim-apis/device/list-live-device-rows)
- [`GET /v1/slim/device/live/telemetry` — List live telemetry and alerts by device](/slim-apis/device/list-live-telemetry-and-alerts-by-device)
- [`GET /v1/slim/device/assign/project` — List projects for device assignment](/slim-apis/device/list-projects-for-device-assignment)
- [`PUT /v1/slim/device/assign/project` — Move device to another project](/slim-apis/device/move-device-to-another-project)
- [`POST /v1/slim/device/routing` — Resolve how ingest routes device serials](/slim-apis/device/resolve-how-ingest-routes-device-serials)
- [`PUT /v1/slim/device/:id` — Update device](/slim-apis/device/update-device)

### Locations [#locations]

- [`POST /v1/slim/location` — Create location](/slim-apis/location/create-location)
- [`POST /v1/slim/location/admin` — Create location in a project (admin)](/slim-apis/location/create-location-in-a-project-admin)
- [`DELETE /v1/slim/location/:id` — Delete location](/slim-apis/location/delete-location)
- [`GET /v1/slim/location/:id` — Get location](/slim-apis/location/get-location)
- [`GET /v1/slim/location/assignment-candidates` — List location assignment candidates](/slim-apis/location/list-location-assignment-candidates)
- [`GET /v1/slim/location` — List locations](/slim-apis/location/list-locations)
- [`GET /v1/slim/location/admin/list` — List locations in a project (admin)](/slim-apis/location/list-locations-in-a-project-admin)
- [`PUT /v1/slim/location/:id` — Update location](/slim-apis/location/update-location)

### Zones [#zones]

- [`POST /v1/slim/zones/:zoneId/locations` — Create location in zone](/slim-apis/zones/create-location-in-zone)
- [`DELETE /v1/slim/zones/:zoneId/locations/:locationId` — Delete location in zone](/slim-apis/zones/delete-location-in-zone)
- [`GET /v1/slim/zones/:zoneId` — Get zone detail](/slim-apis/zones/get-zone-detail)
- [`GET /v1/slim/zones/device-counts` — Get zone device counts](/slim-apis/zones/get-zone-device-counts)
- [`GET /v1/slim/zones` — List zones](/slim-apis/zones/list-zones)
- [`PUT /v1/slim/zones/:zoneId/locations/:locationId` — Update location in zone](/slim-apis/zones/update-location-in-zone)

### Organizations [#organizations]

- [`POST /v1/slim/organization` — Create organization](/slim-apis/organization/create-organization)
- [`DELETE /v1/slim/organization/:id` — Delete organization](/slim-apis/organization/delete-organization)
- [`GET /v1/slim/organization/:id` — Get organization](/slim-apis/organization/get-organization)
- [`PUT /v1/slim/organization/:id` — Update organization](/slim-apis/organization/update-organization)

### Projects [#projects]

- [`POST /v1/slim/project/child` — Create a child project](/slim-apis/project/create-a-child-project)
- [`DELETE /v1/slim/project/child/:subProjectId` — Delete a child project](/slim-apis/project/delete-a-child-project)
- [`GET /v1/slim/project/:id` — Get a project](/slim-apis/project/get-a-project)
- [`GET /v1/slim/project/:id/device-counts` — Get project device counts](/slim-apis/project/get-project-device-counts)
- [`GET /v1/slim/project/:id/patient-counts` — Get project patient counts](/slim-apis/project/get-project-patient-counts)
- [`GET /v1/slim/project/child` — List child project relationships](/slim-apis/project/list-child-project-relationships)
- [`GET /v2/slim/project/child` — List child projects with device counts](/slim-apis/project/list-child-projects-with-device-counts)
- [`GET /v1/slim/project/users` — List current project users](/slim-apis/project/list-current-project-users)
- [`GET /v1/slim/project/:id/users` — List project users](/slim-apis/project/list-project-users)
- [`PUT /v1/slim/project/:id` — Update a project](/slim-apis/project/update-a-project)

### Access policies [#access-policies]

- [`POST /v1/slim/policy` — Create access policy](/slim-apis/policy/create-access-policy)
- [`DELETE /v1/slim/policy/:id` — Delete access policy](/slim-apis/policy/delete-access-policy)
- [`GET /v1/slim/policy/:id` — Get access policy](/slim-apis/policy/get-access-policy)
- [`GET /v1/slim/policy` — List access policies](/slim-apis/policy/list-access-policies)
- [`PUT /v1/slim/policy/:id` — Update access policy](/slim-apis/policy/update-access-policy)

### Practitioners [#practitioners]

- [`GET /v1/slim/practitioner/:id` — Get practitioner](/slim-apis/practitioner/get-practitioner)
- [`PUT /v1/slim/practitioner/:id` — Update practitioner](/slim-apis/practitioner/update-practitioner)

### Invitations [#invitations]

- [`POST /v1/slim/invite/practitioner` — Invite practitioner](/slim-apis/invite/invite-practitioner)

### Notifications [#notifications]

- [`GET /v1/slim/notifications/medical/:episodeId/notes` — A medical notification's notes](/slim-apis/notifications/a-medical-notifications-notes)
- [`GET /v1/slim/notifications/raw-alerts/:alertId/notes` — A raw Signals alert's notes](/slim-apis/notifications/a-raw-signals-alerts-notes)
- [`POST /v1/slim/notifications/medical/:episodeId/ack` — Acknowledge medical notification](/slim-apis/notifications/acknowledge-medical-notification)
- [`PATCH /v1/slim/notifications/:id/ack` — Acknowledge notification](/slim-apis/notifications/acknowledge-notification)
- [`GET /v1/slim/notifications/alarms/:id/notes` — An alarm notification's notes](/slim-apis/notifications/an-alarm-notifications-notes)
- [`GET /v1/slim/notifications/oob/:id/notes` — An out-of-bed notification's notes](/slim-apis/notifications/an-out-of-bed-notifications-notes)
- [`DELETE /v1/slim/notifications/notes/:noteId` — Delete a note](/slim-apis/notifications/delete-a-note)
- [`PATCH /v1/slim/notifications/notes/:noteId` — Edit a note's text](/slim-apis/notifications/edit-a-notes-text)
- [`GET /v1/slim/notifications/medical/:episodeId` — Get medical notification](/slim-apis/notifications/get-medical-notification)
- [`POST /v1/slim/notifications/notes` — Leave a note on a notification](/slim-apis/notifications/leave-a-note-on-a-notification)
- [`GET /v1/slim/notifications/alarms` — List alarm notifications](/slim-apis/notifications/list-alarm-notifications)
- [`GET /v1/slim/notifications/medical` — List medical notifications](/slim-apis/notifications/list-medical-notifications)
- [`GET /v1/slim/notifications/oob` — List out-of-bed notifications](/slim-apis/notifications/list-out-of-bed-notifications)
- [`GET /v1/slim/notifications/recent/alarms` — List recent alarm notifications](/slim-apis/notifications/list-recent-alarm-notifications)
- [`GET /v1/slim/notifications/recent/medical` — List recent medical notifications](/slim-apis/notifications/list-recent-medical-notifications)
- [`GET /v1/slim/notifications/recent` — List recent notifications](/slim-apis/notifications/list-recent-notifications)
- [`GET /v1/slim/notifications/recent/oob` — List recent out-of-bed notifications](/slim-apis/notifications/list-recent-out-of-bed-notifications)
- [`PUT /v1/slim/notifications/notes/:noteId` — Replace a note's text](/slim-apis/notifications/replace-a-notes-text)

### Thresholds [#thresholds]

- [`GET /v2/slim/threshold` — Get current org threshold (v2)](/slim-apis/threshold/get-current-org-threshold-v2)
- [`GET /v1/slim/threshold` — Get current threshold](/slim-apis/threshold/get-current-threshold)
- [`GET /v1/slim/threshold/patient/:patientId` — Get patient effective threshold](/slim-apis/threshold/get-patient-effective-threshold)
- [`GET /v2/slim/threshold/patient/:patientId` — Get patient effective threshold (v2)](/slim-apis/threshold/get-patient-effective-threshold-v2)
- [`GET /v1/slim/threshold/patient/:patientId/vitals` — Get patient vital thresholds](/slim-apis/threshold/get-patient-vital-thresholds)
- [`DELETE /v1/slim/threshold/patient/:patientId/vitals/:code` — Remove a patient vital threshold](/slim-apis/threshold/remove-a-patient-vital-threshold)
- [`PUT /v1/slim/threshold/patient/:patientId/vitals/:code` — Set a patient vital threshold](/slim-apis/threshold/set-a-patient-vital-threshold)
- [`PUT /v2/slim/threshold` — Update org threshold (v2)](/slim-apis/threshold/update-org-threshold-v2)
- [`PUT /v1/slim/threshold/patient/:patientId` — Update patient threshold](/slim-apis/threshold/update-patient-threshold)
- [`PUT /v2/slim/threshold/patient/:patientId` — Update patient threshold (v2)](/slim-apis/threshold/update-patient-threshold-v2)
- [`PUT /v1/slim/threshold` — Update threshold](/slim-apis/threshold/update-threshold)

### Telemetry [#telemetry]

- [`GET /v1/slim/telemetry/:deviceId` — Get device telemetry and alerts](/slim-apis/telemetry/get-device-telemetry-and-alerts)
- [`GET /v1/slim/telemetry/:deviceId/effectiveIds` — Get effective observation ids for a device](/slim-apis/telemetry/get-effective-observation-ids-for-a-device)
- [`GET /v1/slim/telemetry/:deviceId/lastIds` — Get last-received observation ids for a device](/slim-apis/telemetry/get-last-received-observation-ids-for-a-device)
- [`GET /v1/slim/telemetry/effectiveIds` — List effective observation ids by device](/slim-apis/telemetry/list-effective-observation-ids-by-device)
- [`GET /v1/slim/telemetry/lastIds` — List last-received observation ids by device](/slim-apis/telemetry/list-last-received-observation-ids-by-device)

### Trends [#trends]

- [`GET /v1/slim/trends/realtime` — Get realtime trends graphs](/slim-apis/trends/get-realtime-trends-graphs)
- [`GET /v1/slim/trends/graphs` — Get trends graphs](/slim-apis/trends/get-trends-graphs)

### Sleep [#sleep]

- [`GET /v1/slim/sleep/statistics` — Get sleep statistics](/slim-apis/sleep/get-sleep-statistics)

### Reports and exports [#reports-and-exports]

- [`POST /v1/slim/export/pdf` — Create night report PDF](/slim-apis/export/create-night-report-pdf)

### Users [#users]

- [`DELETE /v1/slim/user/:profileType/:profileId` — Delete user](/slim-apis/user/delete-user)
- [`GET /v1/slim/user/consents` — Get all user consents](/slim-apis/user/get-all-user-consents)
- [`GET /v1/slim/user/medical-settings-notifications-consent` — Get medical settings notifications consent (deprecated)](/slim-apis/user/get-medical-settings-notifications-consent)
- [`GET /v1/slim/user/terms-and-conditions-consent` — Get terms and conditions consent](/slim-apis/user/get-terms-and-conditions-consent)
- [`POST /v1/slim/user/support` — Send support message](/slim-apis/user/send-support-message)
- [`POST /v1/slim/user/medical-settings-notifications-consent` — Update medical settings notifications consent (deprecated)](/slim-apis/user/update-medical-settings-notifications-consent)
- [`POST /v1/slim/user/terms-and-conditions-consent` — Update terms and conditions consent](/slim-apis/user/update-terms-and-conditions-consent)
- [`POST /v1/slim/user/consents` — Update user consents](/slim-apis/user/update-user-consents)

### Audit [#audit]

- [`GET /v1/slim/change-history` — List change history](/slim-apis/audit/list-change-history)
