List Campaign Filters
GEThttps://sailpoint.api.identitynow.com/v2025/campaign-filters
Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
Request
Query Parameters
Possible values: <= 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
250
Start/Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
0
If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
true
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of campaign filter objects.
- application/json
- Schema
- Example (auto)
- Example
Schema
items object[]
Number of filters returned.
2
{
"items": [
{
"id": "5ec18cef39020d6fd7a60ad3970aba61",
"name": "Identity Attribute Campaign Filter",
"description": "Campaign filter to certify data based on an identity attribute's specified property.",
"owner": "SailPoint Support",
"mode": "INCLUSION",
"criteriaList": [
{
"type": "IDENTITY_ATTRIBUTE",
"property": "displayName",
"value": "support",
"operation": "CONTAINS",
"negateResult": false,
"shortCircuit": false,
"recordChildMatches": false,
"id": null,
"suppressMatchedItems": false,
"children": null
}
],
"isSystemFilter": false
}
],
"count": 2
}
{
"items": [
{
"id": "5b8a2ba86393dd174495c4436dd76b25",
"name": "IdentityAttribute Inclusion Campaign Filter",
"description": "IdentityAttribute Inclusion Campaign Filter",
"owner": "SailPoint Support",
"mode": "INCLUSION",
"criteriaList": [
{
"type": "IDENTITY_ATTRIBUTE",
"property": "displayName",
"value": "#",
"operation": "CONTAINS",
"negateResult": false,
"shortCircuit": false,
"recordChildMatches": false,
"id": null,
"suppressMatchedItems": false,
"children": null
}
],
"isSystemFilter": false
},
{
"id": "e9f9a1397b842fd5a65842087040d3ac",
"name": "Exclusion Campaign Filter",
"description": "Campaign filter for Exclusion update",
"owner": "SailPoint Support",
"mode": "EXCLUSION",
"criteriaList": [
{
"type": "IDENTITY_ATTRIBUTE",
"property": "displayName",
"value": "#@",
"operation": "CONTAINS",
"negateResult": false,
"shortCircuit": false,
"recordChildMatches": false,
"id": null,
"suppressMatchedItems": false,
"children": null
}
],
"isSystemFilter": false
}
],
"count": 2
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (auto)
Schema
Fine-grained error code providing more detail of the error.
400.1 Bad Request Content
Unique tracking id for the error.
e7eab60924f64aa284175b9fa3309599
messages object[]
causes object[]
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (auto)
Schema
A message describing the error
JWT validation failed: JWT is expired
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (auto)
- 403
Schema
Fine-grained error code providing more detail of the error.
400.1 Bad Request Content
Unique tracking id for the error.
e7eab60924f64aa284175b9fa3309599
messages object[]
causes object[]
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
- application/json
- Schema
- Example (auto)
Schema
A message describing the error
Rate Limit Exceeded
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (auto)
- 500
Schema
Fine-grained error code providing more detail of the error.
400.1 Bad Request Content
Unique tracking id for the error.
e7eab60924f64aa284175b9fa3309599
messages object[]
causes object[]
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}
Authorization: oauth2
type: Personal Access Tokenscopes: idn:campaign-filter-list:read
- go
- powershellSailPoint SDK
- pythonSailPoint SDK
- csharp
- curl
- dart
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- r
- ruby
- rust
- shell
- swift
- NATIVE
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sailpoint.api.identitynow.com/v2025/campaign-filters"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}