Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Rewards

Get reward state history

Returns the full state-transition history for the specified reward.

get/v2/rewards/{reward_id}/history

Path parameters

reward_idstring required

Extole-assigned unique identifier for the reward.

Response

Successful response

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.

messagestring required

Human-readable message associated with this state transition.

operator_user_idstring required

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

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

Lifecycle state type of this reward state transition.

successboolean required

Whether this state transition was successful.

Example response

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