v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

Vouchers

GET vouchers

Returns Vouchers of the administration

get/v3/administrations/{administration_id}/vouchers

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

fields[voucher]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[code]string

Filter on code

filter[email]string

Filter on email

filter[locale]string

Filter on locale

filter[expires_at]string

Filter on expires_at

filter[payments]string

Filter on payments. Specify a comma separated list of IDs to filter on.

include_without_balanceboolean

When true, also returns vouchers that have been fully spent.

include_expiredboolean

When true, also returns vouchers that are expired.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da, de, de-AT, de-CH, en, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr. Default: 'en'.

Response

VoucherCollectionResponse