Skip to main content

List current project users

MethodPath
GET/v1/slim/project/users

Authentication · Access policies

Lists the practitioner memberships of your current project, with each member's user, profile, access policy and invite status. Use it to render a project's team list.

Auth: Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant Practitioner:read (project admins skip this check). The session must carry a project. Scope: The caller's project (from the token).

Behaviour​

  • Returns one row per ProjectMembership of profileType (Practitioner) that has both a user and a profile. Memberships whose user or profile cannot be resolved are left out.
  • status is Pending while the user has an unused invite or has never set a password, and Active otherwise.
  • accessPolicyId, profileId and userId narrow the memberships by exact id.
  • search is a fuzzy match over the profile name, the user name and the access policy name.
  • sortBy defaults to profileName and orderBy to ASC. Rows with an empty sort value go last in ASC and first in DESC.
  • Paging is in memory: page (default 0) and count (default 20, 1 to 100). total counts the rows after search, before paging.
  • Answers are cached for up to about a minute, so a member added or removed a moment ago can be missing or still listed.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/project/users?sortBy=userName&orderBy=ASC&page=0&count=20' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Project users retrieved successfully.

Errors​

StatusMeaning
401The bearer token is missing or invalid.
403The session is not a practitioner, admin or System Owner session, has no project, or its access policy lacks Practitioner:read.
422A query parameter fails validation, for example count above 100.