List campaign templates
Returns scheduled campaign templates — saved configurations that have not yet been activated or are waiting for their next scheduled run. This corresponds to the Scheduled view in the Admin Portal.
Pagination
- skip — Number of records to skip (default 0)
- limit — Page size (default 10, maximum 100)
Sorting — Pass a field name; prefix with - for descending order. Supported fields: name, next_run_at, last_run_at, created_at, enabled Example: sort=-name
Filtering — Repeat filter for multiple clauses (combined with AND). Format: field:operator:value
- status:eq:scheduled — Only scheduled templates are supported on this endpoint. To list active or completed runs, use GET /access-certification/campaign-runs.
- name:eq|ne|search|in|nin:<value> — Filter by campaign name (search is case-insensitive)
- enabled:eq:true|false — Filter by whether auto-start is enabled
- scopeType:eq:application|group — Filter by review scope type
- scopeTargetId:eq|search|ne_search:<id> — Filter by application or user group ID
- frequency:eq:one_time|monthly|quarterly|semi_annual|annual — Filter by schedule frequency
When no status filter is provided, only scheduled templates are returned.
Filter metadata — Set metadata=true to receive distinct applicationIds and userGroupIds for building scope filter dropdowns. When enabled, list rows are omitted (totalCount is 0).
Required permission: accesscertification or accesscertification.readonly
Request
- Base URLhttps://console.jumpcloud.com
- 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 scheduled campaigns in the metadata field (applicationIds, userGroupIds). List rows are omitted.
Response
Paginated list of campaign templates (totalCount + results)
Changes
No recorded changes to this operation across all 1 revision of this API.