Skip to main content
GET
List redemptions

Authorizations

Authorization
string
header
required

Partner API key: Authorization: Bearer vk_live_…. Use vk_test_… keys against the sandbox. See Authentication.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Page size 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string
default:-redeemedAt

One sort field; prefix - for descending (sort=field or sort=-field); id is appended as tie-breaker. Another value is a 400 data-failed-validation with the constraint invalid-sort. Default -redeemedAt.

Example:

"-redeemedAt"

filter[voucherSetId]
string

Filter on voucherSetId (equals).

filter[voucherSetId][in]
string

Filter on voucherSetId (one of, comma-separated). Comma-separated values.

filter[voucherId]
string

Filter on voucherId (equals).

filter[status]
string

Filter on status (equals).

filter[status][in]
string

Filter on status (one of, comma-separated). Comma-separated values.

filter[redeemedAt][gte]
string<date-time>

Filter on redeemedAt (greater than or equal).

filter[redeemedAt][gt]
string<date-time>

Filter on redeemedAt (greater than).

filter[redeemedAt][lt]
string<date-time>

Filter on redeemedAt (less than).

filter[redeemedAt][lte]
string<date-time>

Filter on redeemedAt (less than or equal).

filter[voidedAt][gte]
string<date-time>

Filter on voidedAt (greater than or equal).

filter[voidedAt][lt]
string<date-time>

Filter on voidedAt (less than).

filter[voidedAt][isNull]
boolean

Filter on voidedAt (is null, true or false).

Response

A page of results.

Page envelope of ProviderRedemption.

data
object
required

Page body.