Skip to main content
GET
List voucher redemptions

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Query Parameters

groupId
string
site
string
redeemedAfter
string<date-time>

Inclusive redemption lower bound. Must include an explicit UTC offset. UTC ISO 8601 timestamp.

redeemedBefore
string<date-time>

Inclusive redemption upper bound. Must include an explicit UTC offset. UTC ISO 8601 timestamp.

includeCodes
boolean
default:false

When true, includes fulfillment or voucher codes. Codes are excluded by default because they grant value.

limit
integer
default:100

Page size. Invalid values use 100; values above 500 are capped at 500.

Required range: 1 <= x <= 500
cursor
string

Opaque continuation token returned by this voucher redemptions collection. Cursors are bound to this endpoint (and, for nested or sorted collections, to that parent or sort) and cannot be reused elsewhere.

Response

Tenant-scoped collection.

Standard envelope for canonical collection endpoints.

organizationId
string
required
filters
object
required

Normalized filters actually applied to the request.

data
object[]
required
pagination
object
required