OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources

API reference

Every public route of the Ovok API, with its parameters, responses, errors and a request you can try.

The Ovok API is a JSON API over HTTPS. Each page in this reference covers one operation: what it does, who may call it, its parameters and responses, and a request you can send from the page.

Base URLhttps://api.sandbox.ovok.com
AuthenticationAuthorization: Bearer {{ACCESS_TOKEN}}, from sign-in
FHIRhttps://api.sandbox.ovok.com/fhir/R4/, documented under FHIR R4
Errorsapplication/problem+json, with a stable type URI per error

Errors on every route

Each operation lists its own errors. Any route can also answer with these:

StatusMeaning
401The bearer token is missing, invalid or expired. The response includes WWW-Authenticate: Bearer.
429Too many requests. Wait the seconds in Retry-After, then retry.
500Unexpected server fault. Retry; if it persists, contact support with the traceId.
503Over capacity or briefly unavailable. Wait the seconds in Retry-After, then retry.

Availability

Routes reach the sandbox first, then staging and production. Each operation page shows the environments that serve it. Routes being retired are listed with their sunset date and replacements in deprecated routes.

See also

Last updated on

Fetch data of existing accounts GET

Lists the email addresses of every account in the caller's project. Use it to build a participant picker, for example for a video call. **Auth:** bearer token. The caller must be a Practitioner, a project admin or a super admin, or hold an access policy named "System Owner". Other callers get 403. **Scope:** the project of the token. ## Behaviour - Every project membership with a Patient or Practitioner profile and a User is included. Accounts whose User has no email are left out. - The handler returns only the `email` of each account. - The list is not paginated and has no defined sort order. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/accounts' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

On this page

Errors on every routeAvailabilitySee also