v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Rewards

List rewards

Returns reward records for the client matching the specified query parameters.

get/v2/rewards

Query parameters

statestring

Filter by reward state(s). Repeat for multiple values (e.g. EARNED, FULFILLED).

reward_supplier_idstring

Filter by Extole reward supplier id(s). Repeat for multiple values.

partner_reward_supplier_idstring

Filter by partner-assigned reward supplier id(s). Repeat for multiple values.

person_idstring

Filter by Extole person id(s). Repeat for multiple values.

action_idstring

Filter by Extole action id(s). Repeat for multiple values.

root_event_idstring

Filter by root event id(s). Repeat for multiple values.

partner_reward_idstring

Filter by partner-assigned reward id(s). Repeat for multiple values.

reward_typestring

Filter by reward type(s). Repeat for multiple values.

success_onlyboolean

When true (default), include only rewards that were successfully fulfilled.

time_intervalstring

ISO 8601 time interval to restrict results to a date range (e.g. P30D for last 30 days).

limitinteger

Maximum number of rewards to return. Defaults to 100.

offsetinteger

Number of rewards to skip for pagination. Defaults to 0.

Response

Successful response

action_idstring required

Extole action id associated with this reward.

campaign_idstring required

Extole campaign id associated with this reward.

cause_event_idstring required

Id of the direct cause event that triggered this reward.

containerstring required

Campaign container the reward belongs to.

created_atstring 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.

emailstring nullable required

Email address of the reward recipient. Null if not available.

expires_atstring 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).

journey_namestring required

Name of the journey associated with this reward.

partner_reward_idstring nullable required

Partner-assigned identifier for this reward. Null if not yet assigned.

partner_reward_key_type'COUPON' | 'ID' | 'LINK' required

Type of key used to identify the reward at the partner's system.

partner_reward_supplier_idstring nullable required

Partner-assigned identifier for the reward supplier. Null if not provided.

partner_user_idstring nullable required

Partner's identifier for the person. Null if not provided.

person_idstring required

Extole person id of the reward recipient.

reward_idstring required

Extole-assigned unique identifier for this reward.

reward_supplier_idstring required

Extole reward supplier id that issued this reward.

root_event_idstring required

Id of the root event that initiated the chain leading to this reward.

sandboxstring required

Sandbox identifier for this reward.

Current lifecycle state of the reward.

Example response

[
  {
    "created_at": "2025-10-24T02:00:00-07:00",
    "expires_at": "2025-10-24T02:00:00-07:00"
  }
]