Skip to main content
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

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Participant ID

Query Parameters

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

status
enum<string>

Filter by redemption status

Available options:
PENDING,
COMPLETED,
FAILED,
CANCELLED,
PARTIALLY_REVERSED,
FULLY_REVERSED
reward_catalog_item_id
string<uuid>

Filter by reward catalog item ID

from
string<date-time>

Start of creation-time window (RFC 3339)

to
string<date-time>

End of creation-time window (RFC 3339)

Response

List of redemptions

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results