v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Rewards

Get reward fulfillments

Returns the fulfilment records for the specified reward.

get/v2/rewards/{reward_id}/fulfillments

Path parameters

reward_idstring required

Extole-assigned unique identifier for the reward.

Response

Successful response

amountnumber nullable required

Monetary amount disbursed during fulfillment. Null if not applicable.

cost_codestring nullable required

Cost accounting code used for this fulfillment. Null if not applicable.

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.

face_valuenumber nullable required

Face value of the reward at time of fulfillment. Deprecated.

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

Face value type of the reward at time of fulfillment. Deprecated.

messagestring required

Human-readable message from the fulfillment attempt.

operator_user_idstring required

Extole user id of the operator who triggered this fulfillment, if applicable.

partner_reward_idstring nullable required

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

reward_idstring required

Extole-assigned unique identifier for the reward.

successboolean required

Whether the fulfillment was successful.

Example response

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