Deprecated - Retrieve campaign instances.

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

The api to get campaign instances v1.0 (v1.0/admin/instances) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: GET /v2.0/instances
Get a list of campaign instances. If called by an application owner, the API can get only instances associated to configurations he created or containing at least one Application he owns.
Entitlements required: manageAccessCertification [Manage Access Certification].

Query Params

type

string

Defaults to all

The filter for the campaign instance type: userassignment, groupassignment, or account.

state

array of strings

Defaults to all

The filter for the campaign instance state: noinstance, aborted, closed, completed, created, deleted, failed, paused, running, starting, success.

Multiple values can be selected.

state

priority

string

Defaults to all

The filter for the campaign instance priority: high, medium, or low.

preview

string

Defaults to all

The filter for getting preview campaign instances: yes, no.

continuous

string

Defaults to all

The filter for getting continuous campaign instances: yes, no.

reviewersId

array of strings

The filter for the campaign reviewer.

Provide multiple values in new lines or separated by commas. For example, 607000JX53, 6050001F7Z, 50EEPX4TQC

reviewersId

supervisorsId

array of strings

The filter for the campaign supervisor.

Provide multiple values in new lines or separated by commas. For example, 607000JX53, 6050001F7Z, 50EEPX4TQC

supervisorsId

ownersId

array of strings

The filter for the campaign owner.

Provide multiple values in new lines or separated by commas. For example, 607000JX53, 6050001F7Z, 50EEPX4TQC

ownersId

appsId

array of strings

The filter for the campaign application.

Provide multiple values in new lines or separated by commas. For example,7728662622850583652, 7729580475382480456

appsId

overallState

string

Defaults to all

To filter based on the overall state of the campaign instance. This filter is to logically 'group' the possible campaign instance states: active,inactive.

filter

string

The generic filter for returning campaign instances that contain the passed string in one of the following attributes: name (Campaign instance name).

sort

string

The attribute of the campaign instance that is used to sort results. The possible values are: name, type, priority, status, timelaststart, timeclosed, progress, lastpausedate, timeremaining.

When you provide,
name: The campaign instance name is used for sorting.
type: The campaign instance type is used for sorting.
priority: The campaign instance priority is used for sorting.
status: The campaign instance status is used for sorting.
timelaststart: The campaign instance lastStartDate timestamp is used for sorting.
timeclosed: The campaign instance endDate timestamp is used for sorting.
progress: The campaign instance progress is used for sorting.
lastpausedate: The campaign instance lastPauseDate timestamp is used for sorting.
timeremaining: The campaign instance timeRemaining timestamp is used for sorting.

sortDesc

boolean

Defaults to true

Decides sort order.

limit

string

Defaults to 500

Specifies the maximum number of resources that the search returns for a page.

page

string

Defaults to 1

Page number.

Responses

500

Server error

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://tenant_url/v1.0/admin/instances?type=all&state=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.