Skip to main content

List users (compatibility)

MethodPath
GET/v1/slim/query/user

Authentication · Access policies

Compatibility route for older user list clients. Lists the practitioner users of a project with their profile, membership and access policy. For new integrations, use GET /v1/slim/project/users.

Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Practitioner:read. Scope: the caller's project (from the token). When you pass project=Project/<id>, that project is used instead. It must be your project or one of its sub-projects.

Behaviour​

  • profileType is required and must be Practitioner.
  • Each row has user, profile, membership and, when set, accessPolicy, reduced to the fields a list needs.
  • A user's status is Pending when they have an unused invite or no password yet, otherwise Active.
  • accessPolicy, profile and user filter on exact references, for example AccessPolicy/<id>.
  • search matches profile name, user name and access policy name, with fuzzy matching.
  • page is zero-based. count defaults to 20, maximum 100.
  • Results are cached for up to 60 seconds.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/user?profileType=Practitioner&page=0&count=20' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — User query results retrieved successfully.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack Practitioner:read, or your session has no project.
422A query parameter fails validation.