Get active targets

get

https://{host}/v3/users/{userId}/enrolledTargets

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

targetRuleIds

int64

Rule ID of the target. To fetch the information of a particular target in the API response.

trackingDate

date

The date when the target was created. ISO 8601 format

enrollmentType

string

The target enrollment type refers to the method used to enroll customers and set target values. Possible values are: TRANSACTION, IMPORT, and AUDIENCE_FILTER. TRANSACTION: Enroll loyalty customers who transact during the target period. IMPORT: Import a list of customers with custom target values. AUDIENCE_FILTER: Create audience groups using a predefined audience filter.

includeOnlyUserCreated

boolean

Include only the user-created targets. A user-created target is a promotion that rewards customers for achieving goals they set themselves.

Headers

Authorization

string

X-CAP-API-AUTH-KEY

string

X-CAP-API-AUTH-ORG-ID

string

X-CAP-API-OAUTH-TOKEN

string

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200