List users (compatibility)
| Method | Path |
|---|---|
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
profileTypeis required and must bePractitioner.- Each row has
user,profile,membershipand, when set,accessPolicy, reduced to the fields a list needs. - A user's status is
Pendingwhen they have an unused invite or no password yet, otherwiseActive. accessPolicy,profileanduserfilter on exact references, for exampleAccessPolicy/<id>.searchmatches profile name, user name and access policy name, with fuzzy matching.pageis zero-based.countdefaults 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
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack Practitioner:read, or your session has no project. |
422 | A query parameter fails validation. |