v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Rewards

Get reward redeems

Returns the redemption records for the specified reward.

get/v2/rewards/{reward_id}/redeems

reward_idstring required

Extole-assigned unique identifier for the reward.

Successful response

cause_event_idstring nullable required

Extole id of the event that caused this redemption.

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.

event_namestring nullable required

Name of the event that triggered this redemption. Null if not event-driven.

messagestring nullable required

Human-readable message associated with this redemption. Null if not provided.

operator_user_idstring nullable required

Extole user id of the operator who triggered this redemption. Null if system-initiated.

partner_event_idstring nullable required

Partner-provided identifier for the triggering event. Null if not provided.

partner_reward_redeem_idstring required

Partner-assigned identifier for this redemption event.

reward_idstring required

Extole-assigned unique identifier for the reward.

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