Retrieve campaign instances.

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

Get a list of campaign instances. If called by an application owner, the API can get only instances associated to configurations that the owner created or that contain at least one application that the owner owns.
Entitlements required: manageAccessCertification [Manage Access Certification].

Query Params

type

string

Defaults to all

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

state

array of strings

Filter for campaign state

state

priority

string

Defaults to all

Filter for campaign priority: High, Medium, or Low

preview

string

Defaults to all

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

continuous

string

Defaults to all

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

reviewersId

array of strings

Campaign reviewer IDs

reviewersId

supervisorsId

array of strings

Campaign supervisors IDs

supervisorsId

ownersId

array of strings

Campaign owner IDs

ownersId

appsId

array of strings

Application IDs

appsId

overallState

string

Defaults to all

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

filter

string

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

sort

string

Attribute of the campaign instance that is used to sort results

sortDesc

boolean

Defaults to true

limit

int32

Defaults to 500

page

int32

Defaults to 1

Responses

500

Server error

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://tenant_url/v1.0/admin/instances?type=all&priority=all&preview=all&continuous=all&overallState=all&sortDesc=true&limit=500&page=1' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Success

400Generic application error status. The error code and description are available in the payload.