Skip to main content

Get practitioner

MethodPath
GET/v1/slim/practitioner/:id

Authentication · Access policies

Returns a practitioner profile by id. Use it to show your own profile or, with the extra permission, another practitioner's.

Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant Practitioner:read. Reading another practitioner's profile also needs Practitioner:update. Admins and super admins skip the access-policy check. Scope: Your own profile is always readable. Another practitioner must belong to your project, one of its sub-projects, or its parent project.

Behaviour​

  • Read-only.
  • Your own profile is read with your token. Another practitioner's profile is read with Ovok's admin client after the project check above passes.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/practitioner/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Practitioner profile retrieved successfully.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack Practitioner:read (plus Practitioner:update for someone else's profile), or the practitioner's project is outside your project tree.
404No practitioner with this id exists, or it has no project.