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 and Access policies.

Browse by route group

Health

• GET /v1/slim/health — Get health status

Patients

• POST /v1/slim/patient/check-name-exists — Check patient name exists
• POST /v1/slim/patient — Create patient
• DELETE /v1/slim/patient/:id — Delete patient
• GET /v1/slim/patient/:id — Get patient
• GET /v1/slim/patient/:id/$everything — Get patient $everything
• GET /v1/slim/patient/:id/current-vitals — Get patient current vitals
• GET /v1/slim/patient — List patients
• PUT /v1/slim/patient/:id — Update patient

Devices

• GET /v1/slim/device/live/cloudwatch/:deviceId — Compare device sleep status with ingest logs
• POST /v1/slim/device — Create device
• DELETE /v1/slim/device/:id — Delete device
• GET /v1/slim/device/:id — Get device
• GET /v1/slim/device — List devices
• GET /v1/slim/device/live — List live device rows
• GET /v1/slim/device/live/telemetry — List live telemetry and alerts by device
• GET /v1/slim/device/assign/project — List projects for device assignment
• PUT /v1/slim/device/assign/project — Move device to another project
• POST /v1/slim/device/routing — Resolve how ingest routes device serials
• PUT /v1/slim/device/:id — Update device

Locations

• POST /v1/slim/location — Create location
• POST /v1/slim/location/admin — Create location in a project (admin)
• DELETE /v1/slim/location/:id — Delete location
• GET /v1/slim/location/:id — Get location
• GET /v1/slim/location/assignment-candidates — List location assignment candidates
• GET /v1/slim/location — List locations
• GET /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 zone
• DELETE /v1/slim/zones/:zoneId/locations/:locationId — Delete location in zone
• GET /v1/slim/zones/:zoneId — Get zone detail
• GET /v1/slim/zones/device-counts — Get zone device counts
• GET /v1/slim/zones — List zones
• PUT /v1/slim/zones/:zoneId/locations/:locationId — Update location in zone

Organizations

• POST /v1/slim/organization — Create organization
• DELETE /v1/slim/organization/:id — Delete organization
• GET /v1/slim/organization/:id — Get organization
• PUT /v1/slim/organization/:id — Update organization

Projects

• POST /v1/slim/project/child — Create a child project
• DELETE /v1/slim/project/child/:subProjectId — Delete a child project
• GET /v1/slim/project/:id — Get a project
• GET /v1/slim/project/:id/device-counts — Get project device counts
• GET /v1/slim/project/:id/patient-counts — Get project patient counts
• GET /v1/slim/project/child — List child project relationships
• GET /v2/slim/project/child — List child projects with device counts
• GET /v1/slim/project/users — List current project users
• GET /v1/slim/project/:id/users — List project users
• PUT /v1/slim/project/:id — Update a project

Access policies

• POST /v1/slim/policy — Create access policy
• DELETE /v1/slim/policy/:id — Delete access policy
• GET /v1/slim/policy/:id — Get access policy
• GET /v1/slim/policy — List access policies
• PUT /v1/slim/policy/:id — Update access policy

Practitioners

• GET /v1/slim/practitioner/:id — Get practitioner
• PUT /v1/slim/practitioner/:id — Update practitioner

Invitations

• POST /v1/slim/invite/practitioner — Invite practitioner

Notifications

• GET /v1/slim/notifications/medical/:episodeId/notes — A medical notification's notes
• GET /v1/slim/notifications/raw-alerts/:alertId/notes — A raw Signals alert's notes
• POST /v1/slim/notifications/medical/:episodeId/ack — Acknowledge medical notification
• PATCH /v1/slim/notifications/:id/ack — Acknowledge notification
• GET /v1/slim/notifications/alarms/:id/notes — An alarm notification's notes
• GET /v1/slim/notifications/oob/:id/notes — An out-of-bed notification's notes
• DELETE /v1/slim/notifications/notes/:noteId — Delete a note
• PATCH /v1/slim/notifications/notes/:noteId — Edit a note's text
• GET /v1/slim/notifications/medical/:episodeId — Get medical notification
• POST /v1/slim/notifications/notes — Leave a note on a notification
• GET /v1/slim/notifications/alarms — List alarm notifications
• GET /v1/slim/notifications/medical — List medical notifications
• GET /v1/slim/notifications/oob — List out-of-bed notifications
• GET /v1/slim/notifications/recent/alarms — List recent alarm notifications
• GET /v1/slim/notifications/recent/medical — List recent medical notifications
• GET /v1/slim/notifications/recent — List recent notifications
• GET /v1/slim/notifications/recent/oob — List recent out-of-bed notifications
• PUT /v1/slim/notifications/notes/:noteId — Replace a note's text

Thresholds

• GET /v1/slim/threshold — Get current threshold
• GET /v1/slim/threshold/patient/:patientId — Get patient effective threshold
• GET /v1/slim/threshold/patient/:patientId/vitals — Get patient vital thresholds
• DELETE /v1/slim/threshold/patient/:patientId/vitals/:code — Remove a patient vital threshold
• PUT /v1/slim/threshold/patient/:patientId/vitals/:code — Set a patient vital threshold
• PUT /v1/slim/threshold/patient/:patientId — Update patient threshold
• PUT /v1/slim/threshold — Update threshold

Telemetry

• GET /v1/slim/telemetry/:deviceId — Get device telemetry and alerts
• GET /v1/slim/telemetry/:deviceId/effectiveIds — Get effective observation ids for a device
• GET /v1/slim/telemetry/:deviceId/lastIds — Get last-received observation ids for a device
• GET /v1/slim/telemetry/effectiveIds — List effective observation ids by device
• GET /v1/slim/telemetry/lastIds — List last-received observation ids by device

Trends

• GET /v1/slim/trends/realtime — Get realtime trends graphs
• GET /v1/slim/trends/graphs — Get trends graphs

Sleep

• GET /v1/slim/sleep/statistics — Get sleep statistics

Reports and exports

• POST /v1/slim/export/pdf — Create night report PDF

Queries

• GET /v1/slim/query/organization/device/count — Count devices per zone (compatibility)
• GET /v1/slim/query/patient/:id — Get resident devices with telemetry (compatibility)
• GET /v1/slim/query — List devices with telemetry (compatibility)
• GET /v1/slim/query/telemetry — List telemetry and alerts (compatibility)
• GET /v1/slim/query/user — List users (compatibility)
• GET /v1/slim/query/admin/user — List users across projects (compatibility)

Users

• DELETE /v1/slim/user/:profileType/:profileId — Delete user
• GET /v1/slim/user/consents — Get all user consents
• GET /v1/slim/user/terms-and-conditions-consent — Get terms and conditions consent
• POST /v1/slim/user/support — Send support message
• POST /v1/slim/user/terms-and-conditions-consent — Update terms and conditions consent
• POST /v1/slim/user/consents — Update user consents

Audit

• GET /v1/slim/change-history — List change history