Retrieves a list of campaign configurations from the specific tenant.

The API is used to retrieve list of campaign configurations from the specific tenant.
The administrator managing a specific tenant can see the list of all campaign configurations created for that tenant.
The owners of the application can access the list of campaign configurations 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].

Query Params
string
Defaults to all

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

string
Defaults to all

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

string
Defaults to all

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

string
Defaults to all

The filter for getting campaign configuration in draft mode: yes, no.

string

A generic filter which filters response containing the passed string in any of the following attribute: name (Campaign configuration name).

string

The attribute of the campaign configuration that is used to sort results. The possible values are: owner, launchdate, name, type, priority, createdOn.


When you provide,
owner:The owner's fullName is used for sorting.
launchdate:The campaign configuration launchDate timestamp is used for sorting.
name: The campaign configuration name is used for sorting.
type:The campaign configuration type is used for sorting.
priority:The campaign configuration priority is used for sorting.
createdOn: The campaign configuration creationDate 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