Skip to main content

List project users

MethodPath
GET/v1/slim/project/:id/users

Authentication · Access policies

Lists the practitioner memberships of a given project: your own project or one of its direct child projects. Use it to manage the team of a child project from its parent.

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 project in the path. It must be the caller's project (from the token) or a direct child of it. Grandchildren are not reachable.

Behaviour​

  • The project is read first, so an unknown or out-of-scope id fails before any membership is searched.
  • Rows, filters, sorting, paging and status work exactly as in GET /v1/slim/project/users: one row per Practitioner membership with a user and a profile, search is fuzzy over profile, user and access policy names, count is 1 to 100 (default 20).
  • Answers are cached for up to about a minute.

Example​

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

Successful response​

200 — Project users retrieved successfully.

Errors​

StatusMeaning
400The project is neither the caller's project nor a direct child of it, or it cannot be read.
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 path or query parameter fails validation.