List campaign runs
Returns campaign runs — individual executions of campaign templates. Each run represents one review cycle with a defined review window, progress tracking, and remediation status. This corresponds to the Active and Closed views in the Admin Portal.
Pagination
- skip — Number of records to skip (default 0)
- limit — Page size (default 10, maximum 100)
Sorting — Prefix with - for descending order. Supported fields: campaign_name, review_window_start, review_window_end, review_progress_percent, remediation_status, closed_at, activated_at
Filtering — Repeat filter for multiple clauses (combined with AND).
- status:eq:active|closed|canceled — Filter by run status. When omitted, defaults to active runs. Repeat filters to combine (for example, closed and canceled together).
- campaignName:eq|search:<value> — Filter by campaign name
- scopeType:eq:application|group — Filter by review scope type
- scopeTargetId:eq|search|ne_search:<id> — Filter by application or user group ID
- reviewProgressPercent:eq|gt|lt|ge|le:<0-100> — Filter by review completion percentage
- remediation:in:pending|no_action|completed|scheduled|canceled|not_started — Filter by remediation rollup status
Filter metadata — Set metadata=true to receive distinct applicationIds and userGroupIds for scope filter dropdowns. When enabled, list rows are omitted.
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.
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 scope target IDs for campaign runs in the metadata field (applicationIds, userGroupIds). List rows are omitted.
Response
Paginated list of campaign runs (totalCount + results)
Changes
No recorded changes to this operation across all 1 revision of this API.