v1

latestOpenAPI 3.0.02026-07-243271291.7 MB
SpecialPeriods

GET special_periods

Returns Special Periods of the organization

get/v3/special_periods

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, created_at, updated_at

fields[special_period]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[name]string

Filter on name

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[special_period_entries]string

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

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

SpecialPeriodCollectionResponse