HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Retrieve campaign instances.

get
https://{tenanturl}/v1.0/self/instances

Get campaign instances with at least one record associated with a reviewer or supervisor.
Entitlements required: manageAccessCertification [Manage Access Certification].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Query Params
string
enum
Defaults to all

Filter for campaign type: User, Account, or Group assignments

Allowed:
state
array of strings

Filter for campaign state

state
string
enum
Defaults to all

Filter for campaign priority: High, Medium, or Low

Allowed:
string
enum
Defaults to all

Filter for getting preview campaigns: Yes, No, or All

Allowed:
string
enum
Defaults to all

Filter for getting continuous campaigns: Yes, No, or All

Allowed:
ownersId
array of strings

Campaign owner IDs

ownersId
appsId
array of strings

Application IDs

appsId
string
enum
Defaults to all

Filter for overall campaign state. This filter is to logically 'group' the possible campaign states.

Allowed:
boolean

Consider the calling user as a supervisor of the campaign when calling this API

string
enum
Defaults to assigned

Filter by how the campaigns were assigned to the calling user

Allowed:
string
enum
Defaults to no

Filter for including aggregated data (such as statistics or progress) to the instance objects: Yes, No, or OnlyData

Allowed:
string

Generic filter returning campaigns that contain the passed string in one of the following attributes: campaign.name or campaign.reviewer

string

Attribute of the instance that is used to sort results

boolean
Defaults to true
int32
Defaults to 500
int32
Defaults to 1
Responses

500

Server error

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated over 2 years ago