Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Persons

List person rewards

Returns all rewards for the specified person, sorted by created date in descending order. Supports filtering by state, supplier type, and date range.

get/v5/persons/{person_id}/rewards

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Query parameters

programsstring[]
campaign_idsstring[]
containersstring[]
data_keysstring[]
data_valuesstring[]
reward_typesstring[]
reward_statesstring[]
offsetinteger
limitinteger
journey_namesstring[]
journey_key_namesstring[]
journey_key_valuesstring[]

Response

Successful response

campaign_idstring required

Extole campaign id associated with this reward.

containerstring required

Campaign container the reward belongs to.

created_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

dataobject required

Named data parameters attached to this reward.

earned_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

expiry_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

face_valuenumber required

Monetary or point face value of the reward.

face_value_type'AUD' | 'BRL' | 'CAD' | 'CNY' | 'EUR' | 'GBP' | 'HKD' | 'INR' | 'JPY' | 'KRW' | 'MONTH' | 'MXN' | 'NZD' | 'PERCENT_OFF' | 'POINTS' | 'TRY' | 'TWD' | 'USD' required

Unit type of the face value (e.g. CASH, POINTS, PERCENT).

idstring required

Extole-assigned unique identifier for this reward.

journey_namestring required

Name of the journey associated with this reward.

namestring required

Display name of the reward.

partner_reward_idstring required

Partner-assigned identifier for this reward at the partner's system.

partner_reward_supplier_idstring required

Partner-assigned identifier for the reward supplier.

programstring required

Program key under which the reward was issued.

redeemed_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

reward_supplier_idstring required

Extole reward supplier id that issued this reward.

sandboxstring required

Sandbox identifier for this reward.

state'CANCELED' | 'EARNED' | 'FAILED' | 'FULFILLED' | 'REDEEMED' | 'REVOKED' | 'SENT' required

Current lifecycle state of the reward.

tagsstring[] required

Tags applied to this reward.

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

value_of_rewarded_eventnumber required

Monetary value of the event that triggered this reward.

Example response

[
  {
    "created_date": "2025-10-24T02:00:00-07:00",
    "earned_date": "2025-10-24T02:00:00-07:00",
    "expiry_date": "2025-10-24T02:00:00-07:00",
    "redeemed_date": "2025-10-24T02:00:00-07:00",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]