Get Person Rewards

Calling this endpoint allows you to retrieve a list of a program participant's rewards. The list is sorted by share date in descending order.

Path Params
string
required

Extole's unique profile identifier of the customer.

Query Params
string

A list of program labels configured in Extole (e.g., refer-a-friend). Will include rewards that match at least one of the programs. Multiple states can be filtered by adding the query param multiple times. For example: programs=refer-a-firend&programs=drop-a-hint

string

A list of Extole campaign unique identifiers. Will include rewards that match at least one of the campaign IDs.

string

A list of containers (e.g., test, production, bot). Will include rewards for all containers if not specified or match at least one of the specified containers

string

A list of data keys (e.g., order_id). Will include rewards that match at least one of the data keys.

string

A list of name:value pairs (e.g., order_id:12345). Will include rewards that have at least one of the specified data name-value pairs.

string

A list of reward types (e.g., manual_coupon, salesforce_coupon, tango_v2, custom_reward, paypal_payouts). Will include rewards that match at least one of the reward types.

string

A list of reward states (e.g., SENT, REDEEMED, FAILED, EARNED, CANCELED). Will include rewards that match at least one of the reward states. Multiple states can be filtered by adding the query param multiple times. For example: reward_states=SENT&reward_states=FULFILLED

string

A list of journey names (e.g., advocate, friend). Will include rewards that match at least one of the journey names.

string

A list of journey key names. Will include rewards whose journey key matches one of the journey key names.

string

A list of name:value pairs. Will include rewards that have one of the specified journey keys.

int32

The maximum number of results (max 1000).

int32

The offset for paginating your results.

Headers
string
Defaults to Bearer {access_token}
string
Defaults to application/json
Responses

Language
Credentials
Header
Request
Response
Choose an example:
application/json