Skip to main content
GET
Get a paginated list of vouchers belonging to a voucher group

Path Parameters

id
number
required

Used to identify the voucher group throughout the Spirii system

Query Parameters

createdAt
string<date-time>

Creation date.

createdAtFrom
string<date-time>

Start date for filtering by creation date. When set, filter sort_by defaults to createdAt.

createdAtTo
string<date-time>

End date for filtering by creation date. When set, filter sort_by defaults to createdAt.

updatedAt
string<date-time>

Last update date.

updatedAtFrom
string<date-time>

Start date for filtering by last update date. When set, filter sort_by defaults to updatedAt.

updatedAtTo
string<date-time>

End date for filtering by last update date. When set, filter sort_by defaults to updatedAt.

limit
integer
default:50

Filter the total amount of items returned.

Required range: x >= 1
after
string

The cursor to start fetching records after (forward pagination).

Example:

"My0xMDAw"

before
string

The cursor to start fetching records before (backward pagination).

Example:

"Ny0xMDAw"

sort_by
enum<string>
default:id

Which property to sort by. When used with createdAt* default is createdAt. When used with updatedAt* default is updatedAt.

Available options:
id,
name,
createdAt,
updatedAt
sort_direction
enum<string>
default:asc

Sort direction. Defaults to asc.

Available options:
desc,
asc

Search across item names and IDs.

Response

200 - application/json

The returned list of vouchers belonging to voucher groups.

data
object[]
required

A list of Vouchers.

pagination
object
required