OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
Organization Code Information

Get organization code

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/organizations/code

Returns the tenant code of the caller's project. Users type the code on sign-in screens to choose their organization.

Auth: bearer token. Scope: the caller's project (from the token).

Behaviour

  • The response holds code and projectId.
  • If the project has no tenant code, the request fails with 400 (Tenant code not found).
  • If more than one code row exists for a project, the most recently updated one is returned.

Example

curl -X GET 'https://api.sandbox.ovok.com/organizations/code' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Response Body

The tenant code of the caller’s project.

application/json
  1. response

Tenant code of the caller’s project.

code*string

Tenant code of the project.

projectId*string

ID of the project.

Example Request
curl -X GET 'https://api.sandbox.ovok.com/organizations/code'
Example Response
{  "code": "string",  "projectId": "string"}

Email organization codes POST

Emails a user the tenant codes of every organization (project) they have an account in. Use it on a sign-in screen for users who forgot their organization code. **Auth:** none. ## Behaviour - The route always answers 202 with no body and does the work in the background, so the answer does not tell you whether the email has an account. - The background job finds every account with this email, then looks up the tenant code of each project. If there are no accounts or no codes, no email is sent. - The email lists each project's name and code. It uses the `PATIENT_ORGANIZATION_CODES` template when the first account found is a Patient, and `OVOK_ORGANIZATION_CODES` otherwise. Language and domain come from the request. - The email address is lowercased. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/organizations/code/email' \ -H 'Content-Type: application/json' \ -d '{ "email": "max.mustermann@example.com" }' ```

Get patient sharing settings GET

Returns the caller's project settings for data sharing: whether patients may share their data with each other, and whether the patient and practitioner invites (`/v1/invites`) are on. **Auth:** bearer token of a project admin. **Scope:** the caller's project (from the token). ## Behaviour - `enabled`: patient-to-patient sharing is on. Off unless an admin turned it on. - `accessPolicyId`: the ID of the read-only template AccessPolicy every patient-to-patient share points at, or `null` while none has been created. - `practitionerSharingEnabled`: the `/v1/invites` routes are on. Off unless an admin turned it on. - `practitionerAlertDigest`: whether the clinician alert digest is on and how many hours apart it goes out. Off, every 6 hours, unless an admin set it. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/patient-sharing/settings' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```