Retrieves the list of a campaign instances associated with the specified campaign configuration from the specific tenant.

The API is used to retrieves the list of a campaign instances associated with the specified campaign configuration from the specific tenant.
The owners of the application can access the list of campaign instances that are created by them or includes at least one application owned by them.
Unspecified filter parameters are treated as having the default values.
Every provided parameter value is considered as an extra filter for the search criteria.
Entitlements required: manageAccessCertification [Manage Access Certification].

Path Params
string
required

Campaign Configuration ID

Query Params
string
Defaults to all

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

boolean

Consider the calling user as a supervisor of the campaign when set to true.

string
Defaults to assigned

Filter by which the campaigns were assigned to the calling user: assigned, delegated.

string

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

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.

boolean
Defaults to true

Decides sort order.

string
Defaults to 500

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

string
Defaults to 1

Page number.

Headers
boolean
required

If the value is set to true, the API call is treated as an admin API call.

Responses

500

Your request cannot be processed because an internal server error occurred.

Language
URL
Choose an example:
application/json