Skip to main content
GET
Get reward redeems

Authorizations

Authorization
string
header
required

Path Parameters

reward_id
string
required

Extole-assigned unique identifier for the reward.

Response

Successful response

cause_event_id
string | null
required

Extole id of the event that caused this redemption.

created_at
string
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.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

event_name
string | null
required

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

message
string | null
required

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

operator_user_id
string | null
required

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

partner_event_id
string | null
required

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

partner_reward_redeem_id
string
required

Partner-assigned identifier for this redemption event.

reward_id
string
required

Extole-assigned unique identifier for the reward.