List review items
Returns the identities under review in a campaign run. Each review item includes a frozen snapshot of the user's directory attributes at campaign activation, their current decision status, remediation progress, and reviewer chain state.
Administrators see all identities in the run. Reviewers see only identities assigned to them.
Pagination — skip and limit (default 10, maximum 100).
Sorting — display_name, decision, remediation_action (prefix with - for descending).
Filtering — Repeat filter for multiple clauses. Format: field:operator:value
- actionable:eq:true — (Administrators only) Identities awaiting an administrator-stage decision. Use this to find work items from the admin queue.
- decision:eq|in:pending|keep|revoke|in_progress — Filter by overall decision status
- remediationAction:eq|in:pending|no_action|scheduled|completed|failed|canceled — Filter by remediation status
- directoryStatus:eq|in:<value> — Filter by directory status (frozen at activation; alias: userStatus)
- employeeType:eq|in:<value> — Filter by employee type (frozen at activation)
- department:eq|in:<value> — Filter by department (pipe-separated for multiple values)
- costCenter:eq|in:<value> — Filter by cost center
- company:eq|in:<value> — Filter by company
- lastAccessedAt:gt|ge|lt|le:<RFC3339> — Filter by last SSO login (application-scoped campaigns only)
- name:search:<term> — Search by display name, email, or username
Filter metadata — Set metadata=true to receive distinct values for departments, companies, costCenters, employeeTypes, and directoryStatuses to populate filter dropdowns.
Required permission: accesscertification or accesscertification.readonly
Request
- Base URLhttps://console.jumpcloud.com/api/v2
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Campaign run public identifier (hex-encoded BSON ObjectID stored as object_id).
Query parameters
Number of results to skip
Number of records to skip before returning results (Collection API pagination offset).
Maximum number of results to return
Maximum number of records to return per page (Collection API).
Default is 10 when omitted. Maximum is 100.
Sort expression for the collection. Prefix a field with - for descending order (for example, -created_at).
Supported fields vary by endpoint — see the operation description for allowed sort keys.
Collection filter clause(s) in field:operator:value form. Repeat the query parameter to combine multiple clauses (logical AND).
Operators: eq, ne, search, in, nin (availability varies by field).
Examples:
- filter=status:eq:scheduled
- filter=name:search:quarterly
- filter=decision:eq:pending&filter=remediationAction:eq:scheduled
Supported fields and operators for each list endpoint are documented on that operation's description.
When true, include distinct filter-option values for this campaign run in the metadata field (departments, companies, costCenters, employeeTypes, directoryStatuses).
Response
Review items retrieved successfully
Changes
No recorded changes to this operation across all 1 revision of this API.