HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Deprecated - Retrieve the campaign configurations.

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

The api to get a campaign configurations v1.0 (v1.0/admin/campaigns) is deprecated. The end of life is 31-Dec-2025. Use the following alternative API: GET /v2.0/campaigns
API request is only valid for resources created using V1 version. Attempting to access V2-exclusive resources with the V1 API will result in a 400 error. Additionally, V2 resources are excluded from V1 API filter search results.
Get campaign configurations and manage them. The administrator can see all the campaign configurations for the specified tenant. Application owner can see only the campaigns he created OR those containing at least one Application he owns.
Entitlements required: manageAccessCertification [Manage Access Certification].

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

LoadingLoading

Query Params
string
Defaults to all

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

string
Defaults to all

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

string
Defaults to all

The filter for getting preview campaign configurations: 'all', 'yes', 'no'.

string
Defaults to all

The filter for getting continuous campaign configurations: 'all', 'yes', 'no'.

string

The generic filter for returning campaign configurations that contain the passed string in one of the following attributes: 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.


When you provide,
owner:The owner's fullName is used for sorting.
launchdate:The 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.

Responses

500

Server error

Updated 8 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated 8 months ago