Skip to main content
GET
/
v1
/
participants
/
{id}
/
redemptions
List participant redemptions
curl --request GET \
  --url https://api.scrip.dev/v1/participants/{id}/redemptions \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "amount": "1000.00",
      "asset_id": "550e8400-e29b-41d4-a716-446655440003",
      "created_at": "2024-01-15T10:30:00Z",
      "description": "Redeemed: Gift Card",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "journal_entry_id": "550e8400-e29b-41d4-a716-446655440005",
      "participant_id": "550e8400-e29b-41d4-a716-446655440002",
      "program_id": "550e8400-e29b-41d4-a716-446655440001",
      "quantity": 2,
      "reversed_amount": "0.00",
      "reversed_quantity": 0,
      "reward_id": "550e8400-e29b-41d4-a716-446655440004",
      "status": "COMPLETED",
      "unit_cost": "500.00",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}
Lists all redemptions for a participant, including both raw redemptions and catalog redemptions. Filter by status or reward_catalog_item_id, and use from / to to scope results to a time window. 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.
For usage patterns and examples, see the Redemptions 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:
COMPLETED,
PARTIALLY_REVERSED,
FULLY_REVERSED
​
reward_catalog_item_id
string<uuid>

Filter by reward catalog item ID

​
from
string<date-time>

Start of time window (RFC 3339)

​
to
string<date-time>

End of 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