GET reservations

get

https://api.bookingexperts.com/v3/reservations

Returns reservations that are part of the current organization. When using the channel::reservation|read scope, only reservations of linked channels are returned.

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, start_date, end_date, created_at_date, created_at, updated_at

fields[reservation]

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[start_date]

string

Filter on start_date

filter[end_date]

string

Filter on end_date

filter[late_checkout]

string

Filter on late_checkout

filter[remote_reservation_key]

string

Filter on remote_reservation_key

filter[guest_name]

string

Filter on guest_name

filter[payment_guarantee]

string

Filter on payment_guarantee

filter[note]

string

Filter on note

filter[fixed_rentable]

string

Filter on fixed_rentable

filter[price_according_to_channel_calculation]

string

Filter on price_according_to_channel_calculation

filter[checked_in_on]

string

Filter on checked_in_on

filter[checked_out_on]

string

Filter on checked_out_on

filter[cancellation_insurance]

string

Filter on cancellation_insurance

filter[letter_in_booking]

string

Filter on letter_in_booking

filter[created_at_date]

string

Filter on created_at_date

filter[access_code]

string

Filter on access_code

filter[stay_reason]

string

Filter on stay_reason

filter[created_at]

string

Filter on created_at

filter[updated_at]

string

Filter on updated_at

filter[category]

string

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

filter[rentable_type]

string

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

filter[rentable_identity]

string

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

filter[inventory_object]

string

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

filter[booking]

string

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

filter[order]

string

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

filter[primary_package]

string

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

filter[extra_packages]

string

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

filter[extra_order_items]

string

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

filter[cancellation_rules]

string

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

filter[reservation_amenities]

string

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

filter[labels]

string

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

filter[administration]

string

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

filter[discount_action]

string

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

filter[main_order_items]

string

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

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

200ReservationCollectionResponse

429Error

defaultError