List participant redemptions
Redemptions
List participant redemptions
List redemptions for a participant. The from and to filters use redemption creation (authorization) time, including for redemptions captured later.
GET
List participant redemptions
Lists all redemptions for a participant, including amount and catalog redemptions. Filter by any lifecycle status or
reward_catalog_item_id. Results are ordered by creation time, most recent first.
Each entry contains the redemption ID, asset, amount, status, and for catalog redemptions, the reward_id and quantity.
from and to filter on creation time. For a pending redemption, this is authorization time. A redemption authorized in June and captured in July appears in a June-filtered list, while reporting recognizes it in July.
For the distinction between authorization and recognition time, see the Redemption lifecycle guide.
Authorizations
API key passed in the X-API-Key header.
Path Parameters
Participant ID
Query Parameters
Maximum number of results (default 50, max 200)
Required range:
x >= 1Pagination cursor from previous response
Filter by redemption status
Available options:
PENDING, COMPLETED, FAILED, CANCELLED, PARTIALLY_REVERSED, FULLY_REVERSED Filter by reward catalog item ID
Start of creation-time window (RFC 3339)
End of creation-time window (RFC 3339)