Skip to main content
Version: Latest (4.0.6)

List users available for review in a campaign

POST 
/recertification/campaigns/:campaignID/review

Returns paginated users the caller may review within a campaign.

Scope: cidaas:campaign_review. Management scopes are not accepted; anonymous token sub is rejected with 401. Only groups where the caller is listed in groups[].reviewers are returned.

Filtering:

  • Optional groupIds must be a subset of campaign groups; unknown group → 400.
  • Only groups where caller's sub appears in groups[].reviewers are included.
  • Caller with no access to any group → 403.
  • Graph filters and matchCondition are cleared server-side (ignored).

Pagination: from defaults to 0; size defaults to 100, max 500.

Sort: sortfield or dateField.field; allowed: createdTime, updatedTime, reviewedTime (default). descending is forced to true after validation.

Ordering: Pending users (NOT_STARTED and IN_PROGRESS) appear first, ordered by last reviewed time descending within the pending band; COMPLETED users appear last.

Status filter (reviewStatus request field):

  • PENDING — returns users who are NOT_STARTED or IN_PROGRESS (pending tab).
  • COMPLETED — returns only fully reviewed users.
  • omitted / "" —returns all users.

Tab badge counts: totalPending and totalCompleted are always included in the response regardless of which reviewStatus filter is active — the UI can populate both tab badges from a single request.

Empty page: when no users match the filter the response is still 200 with users: [] and the full badge counts.

Review visibility: for incomplete groups, only the caller's own review line is returned in groups[].review; completed groups omit review details.

User reviewStatus values:

  • NOT_STARTED: no reviewer has voted on any applicable group yet.
  • IN_PROGRESS: at least one applicable group review incomplete, but some activity exists.
  • COMPLETED: all applicable groups complete for this user (caller-scoped for PARALLEL_ALL).

Request​

Responses​

User page