get https://example-client-domain.extole.io/api/v4/me/rewards
Calling this endpoint provides the user with a history of all their earned rewards. This is a verified API, meaning it requires the user to have a verified token before the API may be called. Please note that most customers will use the Content API (advocate_mobile_experience) to get this data in a more precise and tailored way.
Response Data Fields
Field | Description |
---|---|
reward_id | The unique reward identifier. |
amount | The amount value of the reward. This will reflect either a coupon value amount or a Tango gift card. |
face_value_type | Indicates if the reward is USD, GBP, EUR or Percent off. |
type | The type of reward, such as ACCOUNT_CREDIT , COUPON , or GIFTCARD . |
code | The coupon code. This is only available for a coupon-type reward. |
date_issued | The date the reward was issued to the person's profile in ISO 8601 format. |
date_delivered | The date the reward was delivered (via email or SMS). This may be different from the date issued. |
tags | An array of tags for the reward. The rewards are typically tagged as advocate or friend depending on the context in which the person earned the reward. |