v1

latestOpenAPI 3.0.02026-07-243271291.7 MB
Channels

GET channels

Returns channels of the administration

get/v3/administrations/{administration_id}/channels

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

fields[channel]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[kind]string

Filter on kind

filter[requires_night_prices]string

Filter on requires_night_prices

filter[rent_invoiced_to]string

Filter on rent_invoiced_to

filter[costs_invoiced_to]string

Filter on costs_invoiced_to

filter[use_costs_invoiced_to]string

Filter on use_costs_invoiced_to

filter[extras_invoiced_to]string

Filter on extras_invoiced_to

filter[use_extras_invoiced_to]string

Filter on use_extras_invoiced_to

filter[supports_group_details]string

Filter on supports_group_details

filter[confirm_reservations]string

Filter on confirm_reservations

filter[auto_deliver_invoices]string

Filter on auto_deliver_invoices

filter[customer_invoice_payable_on_park]string

Filter on customer_invoice_payable_on_park

filter[archived]string

Filter on archived

filter[temporary_booking_validity_in_hours]string

Filter on temporary_booking_validity_in_hours

filter[price_factor]string

Filter on price_factor

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[administration]string

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

filter[application]string

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

filter[brand]string

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

filter[contact]string

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

filter[guest_payment_policy]string

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

filter[channel_payment_policy]string

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

filter[excluded_costs]string

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

include_archivedboolean

When true, archived channels are included in the response

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

ChannelCollectionResponse