GET vouchers

get

https://api.bookingexperts.com/v3/administrations/{administration_id}/vouchers

Returns Vouchers of the administration

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

administration_id

string

required

Administration ID

Query Params

page[number]

integer

≥ 1

Page number

page[size]

integer

1 to 100

Page size

sort

string

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

include

string

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_balance

boolean

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

include_expired

boolean

When true, also returns vouchers that are expired.

Headers

Accept-Language

string

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'.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200VoucherCollectionResponse

429Error

defaultError