List Campaigns

GET {{baseUrl}}/campaigns

Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent here. - UserContextAuth: []

Request Params

Key	Datatype	Description
`detail`	string	Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
`limit`	number	Max number of results to return.
See V3 API Standard Collection Parameters for more information.
`offset`	number	Offset into the full result set. Usually specified with limit to paginate through the results.
See V3 API Standard Collection Parameters for more information.
`count`	boolean	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

See V3 API Standard Collection Parameters for more information. | | filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters

Filtering is supported for the following fields and operators:

id: eq, in

name: eq, sw

Sorting is supported for the following fields: name, created |

HEADERS

Key	Datatype	Required	Description
`Accept`	string

RESPONSES

status: OK

[{&quot;id&quot;:&quot;078696a575e045c68d6722ccdb9f101d&quot;,&quot;name&quot;:&quot;Role Composition Campaign&quot;,&quot;description&quot;:&quot;A review done by a role owner.&quot;,&quot;deadline&quot;:&quot;2020-12-25T06:00:00.468Z&quot;,&quot;type&quot;:&quot;ROLE_COMPOSITION&quot;,&quot;status&quot;:&quot;ERROR&quot;,&quot;emailNotificationEnabled&quot;:false,&quot;autoRevokeAllowed&quot;:false,&quot;recommendationsEnabled&quot;:false,&quot;modified&quot;:&quot;2022-08-02T20:29:51.331Z&quot;,&quot;filter&quot;:{&quot;type&quot;:&quot;CAMPAIGN_FILTER&quot;,&quot;id&quot;:&quot;0fbe863c063c4c88a35fd7f17e8a3df5&quot;,&quot;name&quot;:&quot;Test Role Composition Filter&quot;},&quot;sunsetCommentsRequired&quot;:true,&quot;sourceOwnerCampaignInfo&quot;:null,&quot;searchCampaignInfo&quot;:null,&quot;roleCompositionCampaignInfo&quot;:{&quot;remediatorRef&quot;:{&quot;type&quot;:&quot;IDENTITY&quot;,&quot;id&quot;:&quot;7ec252acbd4245548bc25df22348cb75&quot;,&quot;name&quot;:&quot;SailPoint Support&quot;},&quot;reviewerId&quot;:null,&quot;reviewer&quot;:null,&quot;roleIds&quot;:[&quot;b15d609fc5c8434b865fe552315fda8f&quot;],&quot;query&quot;:null,&quot;description&quot;:null},&quot;sourcesWithOrphanEntitlements&quot;:null,&quot;mandatoryCommentRequirement&quot;:&quot;NO_DECISIONS&quot;},{&quot;id&quot;:&quot;1be8fc1103914bf0a4e14e316b6a7b7c&quot;,&quot;name&quot;:&quot;Manager Review&quot;,&quot;description&quot;:&quot;A review of everyone&#39;s access by their manager.&quot;,&quot;deadline&quot;:&quot;2020-12-25T06:00:00.468Z&quot;,&quot;type&quot;:&quot;MANAGER&quot;,&quot;status&quot;:&quot;STAGED&quot;,&quot;emailNotificationEnabled&quot;:false,&quot;autoRevokeAllowed&quot;:false,&quot;recommendationsEnabled&quot;:false,&quot;modified&quot;:&quot;2022-08-02T19:00:34.391Z&quot;,&quot;filter&quot;:{&quot;type&quot;:&quot;CAMPAIGN_FILTER&quot;,&quot;id&quot;:&quot;0fbe863c063c4c88a35fd7f17e8a3df5&quot;,&quot;name&quot;:&quot;Test Manager Filter&quot;},&quot;sunsetCommentsRequired&quot;:true,&quot;sourceOwnerCampaignInfo&quot;:null,&quot;searchCampaignInfo&quot;:null,&quot;roleCompositionCampaignInfo&quot;:null,&quot;sourcesWithOrphanEntitlements&quot;:[],&quot;mandatoryCommentRequirement&quot;:&quot;NO_DECISIONS&quot;},{&quot;id&quot;:&quot;7e1a731e3fb845cfbe58112ba4673ee4&quot;,&quot;name&quot;:&quot;Search Campaign&quot;,&quot;description&quot;:&quot;Search Campaign for Identities&quot;,&quot;deadline&quot;:&quot;2022-07-26T15:42:44.000Z&quot;,&quot;type&quot;:&quot;SEARCH&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;emailNotificationEnabled&quot;:false,&quot;autoRevokeAllowed&quot;:false,&quot;recommendationsEnabled&quot;:false,&quot;modified&quot;:&quot;2022-07-25T15:42:53.718Z&quot;,&quot;filter&quot;:{&quot;type&quot;:&quot;CAMPAIGN_FILTER&quot;,&quot;id&quot;:&quot;0fbe863c063c4c88a35fd7f17e8a3df5&quot;,&quot;name&quot;:&quot;Test Search Filter&quot;},&quot;sunsetCommentsRequired&quot;:true,&quot;sourceOwnerCampaignInfo&quot;:null,&quot;searchCampaignInfo&quot;:{&quot;type&quot;:&quot;IDENTITY&quot;,&quot;description&quot;:&quot;Example of Search Campaign&quot;,&quot;reviewer&quot;:{&quot;type&quot;:&quot;IDENTITY&quot;,&quot;id&quot;:&quot;7ec252acbd4245548bc25df22348cb75&quot;,&quot;name&quot;:null},&quot;query&quot;:&quot;user&quot;,&quot;identityIds&quot;:null,&quot;accessConstraints&quot;:[]},&quot;roleCompositionCampaignInfo&quot;:null,&quot;sourcesWithOrphanEntitlements&quot;:[],&quot;mandatoryCommentRequirement&quot;:&quot;NO_DECISIONS&quot;},{&quot;id&quot;:&quot;ad3cf3dd50394b1bad646de4bc51b999&quot;,&quot;name&quot;:&quot;Source Owner Campaign&quot;,&quot;description&quot;:&quot;Example for Source Owner Campaign&quot;,&quot;deadline&quot;:&quot;2022-08-10T17:09:02.000Z&quot;,&quot;type&quot;:&quot;SOURCE_OWNER&quot;,&quot;status&quot;:&quot;ACTIVE&quot;,&quot;emailNotificationEnabled&quot;:true,&quot;autoRevokeAllowed&quot;:false,&quot;recommendationsEnabled&quot;:false,&quot;modified&quot;:&quot;2022-07-27T17:09:13.925Z&quot;,&quot;filter&quot;:{&quot;type&quot;:&quot;CAMPAIGN_FILTER&quot;,&quot;id&quot;:&quot;0fbe863c063c4c88a35fd7f17e8a3df5&quot;,&quot;name&quot;:&quot;Test Source Owner Filter&quot;},&quot;sunsetCommentsRequired&quot;:true,&quot;sourceOwnerCampaignInfo&quot;:{&quot;sourceIds&quot;:[&quot;2c91808781fd5aea01821200dc88318e&quot;]},&quot;searchCampaignInfo&quot;:null,&quot;roleCompositionCampaignInfo&quot;:null,&quot;sourcesWithOrphanEntitlements&quot;:[],&quot;correlatedStatus&quot;:&quot;CORRELATED&quot;,&quot;mandatoryCommentRequirement&quot;:&quot;NO_DECISIONS&quot;}]