Skip to content
Okta Identity Governance
/
Management APIs
/
/
List all campaigns

List all campaigns

Request

OAuth 2.0 scope:
  • okta.governance.accessCertifications.read
Admin roles:
  • ACCESS_CERTIFICATIONS_ADMIN

Lists all or a subset of campaigns in your organization.

Use the ?filter= parameter to narrow results with the following campaign properties - name, status, scheduleType, reviewerType, startDate, endDate, and recurringCampaignId.

Use the ?orderBy= parameter to get ordered results with the following campaign properties - name, created, startDate, endDate, and status.

By default, results are sorted by created.

Query
filterstring

Apply various filters by using supported campaign filtering properties.

Note: Query parameter percent encoding is required. See Percent-encoding

Examples:
Filter by campaign name
filter=name eq "Sales Review"
Filter by campaign status
filter=status eq "SCHEDULED"
Filter by multiple campaign status
filter=status eq "COMPLETED" OR status eq "SCHEDULED"
Filter by start date
filter=startDate gt "2022-05-24T14:15:22Z"
Filter by end date
filter=endDate gt "2022-05-24T14:15:22Z"
FilterByScheduleTypeOneOff
filter=scheduleType eq ONE_OFF
FilterByScheduleTypeRecurring
filter=scheduleType eq RECURRING
FilterByReviewerTypeUser
filter=reviewerType eq USER
FilterByReviewerTypeGroup
filter=reviewerType eq GROUP
FilterByReviewerTypeGroupOwner
filter=reviewerType eq RESOURCE_OWNER
FilterByReviewerTypeMultiLevel
filter=reviewerType eq MULTI_LEVEL
FilterByRecurringCampaignId
filter=recurringCampaignId eq "icijNW29nev6qyksD0g1"
afterstring

Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the standard link headers. See pagination.

Example:after=00u68w6vzKLultXS97g6
limitinteger, [ 1 .. 200 ]

The maximum number of records returned in a response

Default:20
orderByArray of strings, = 1 items

Apply an ordering of campaigns by specifying a supported campaign property name with %20asc or %20desc suffix.

Note: Query parameter percent encoding is required. See Percent-encoding

Default:["created asc"]
Examples:
Order by name
orderBy=name desc
Order by created
orderBy=created desc
Order by startDate
orderBy=startDate desc
Order by endDate
orderBy=endDate desc
Order by status
orderBy=status desc
GET
/governance/api/v1/campaigns
curl -i -X GET \
  'https://okta-subdomain.pixtulate.com/governance/api/v1/campaigns?filter=name%20eq%20%22Sales%20Review%22&after=00u68w6vzKLultXS97g6&limit=20&orderBy=name%20desc'

Responses

A successful campaign list response

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Bodyapplication/json
dataArray of objects(campaign-sparse)required

Sparse representation of a Campaign resource.

Response
The list of campaigns which is filtered by specific name of the campaign
{
  "data": [
    { … },
    { … }
  ],
  "_links": {
    "next": { … },
    "self": { … }
  }
}