GET availabilities

Fieldset. Specify a comma separated list of attributes to return

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

Specify a comma separated list of channel IDs to be used for searching availability. By default, all accessible channels associated to your app will be used. Overriding this may be useful when you have access to multiple channels of the same administration.

When true, the amount of results per global segment will be added to the metadata. DEPRECATED: use include_semantic_segment_counts instead.

When true, the amount of results per global segment will be added to the metadata.

When true, the amount of results per amenity will be added to the metadata

Referrer name

Filter on start date. Expects a date range. Note: date ranges have an exclusive end date.

Filter availabilities that (partially) overlap these dates.

Filter availabilities that contain the specified date range.

Filter on availabilities that exactly match the supplied date range.

Filter on length of stay.

Filter on a particular week day. 0 = sunday.

Filter on administrations. Specify a comma separated list.

Filter on types. Specify a comma separated list.

Exclude types. Specify a comma separated list.

Filter on types. Specify a comma separated list. DEPRECATED: use filter[rentable_type_ids] instead.

Exclude types. Specify a comma separated list. DEPRECATED: use filter[-rentable_type_ids] instead.

Filter on regions. Specify a comma separated list.

Exclude regions. Specify a comma separated list.

Filter on rentable segments. Specify a comma separated list.

Exclude rentable segments. Specify a comma separated list.

Filter on amenities. Specify a comma separated list.

Filter on package ID.

Filter on discount campaign ID.

Filter on inventory object ID.

Filter on owner promotion token.

Filter on country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes. For example: NL,EN,DE.

Exclude country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes.

Filter on global segments. DEPRECATED: use filter[semantic_segments] instead. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

Exclude global segments. DEPRECATED: use filter[-semantic_segments] instead. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

Filter on global segments. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

Exclude global segments. Specify a comma separated list. Available global segments: house, pitch, room, berth, apartment, other, year_site, b_and_b, bungalow, cabin, campervan_pitch, caravan_pitch, chalet, cottage, glamping_tent, hotel_room, houseboat, mobile_home, tent_pitch, tiny_house, treehouse, villa.

Filter on number of seniors.

Filter on number of adults.

Filter on number of adolescents.

Filter on number of children.

Filter on number of babies.

Filter on number of pets.

Filter on a price range

Filter on a specific ISO 4217 currency code. By default the prices are returned in the administration's native currency. Results can differ per currency.

Filter on type number of bedrooms

Filter on type number of beds

Filter on type number of showers

Filter on type number of toilets

Filter on type number of bathrooms

Filter on type number of parking spots

Filter on type number of child beds

Filter on type number of child chairs

Specify a comma separated list of sorters to apply. There are 10 possible sorters:

• los Order by length of stay
• los_distance Order by the distance of a particular length of stay
• start_date Order by start dates
• start_date_distance Order by the distance of a particular start date
• arrangement_distance Order by the distance of a particular arrangement
• max_guests Order by maximum guests of the type
• highlighted Order by availabilities that have a type that is highlighted
• all_in_amount Order by price
• amenity_ids_match_score Order by whether the amenities match
• avg_score Order by average review score of the type

Configuration for each applied sorter (for example descending order) must be passed separately, see the options below.

Boolean specifying the sort direction for the los sorter. When unspecified, ascending order is implied.

Boolean specifying the sort direction for the los_distance sorter. When unspecified, ascending order is implied.

Length of stay for the los_distance sorter

Boolean specifying the sort direction for the start_date sorter. When unspecified, ascending order is implied.

Boolean specifying the sort direction for the start_date_distance sorter. When unspecified, ascending order is implied.

Start date for the start_date_distance sorter

Boolean specifying the sort direction for the arrangement_distance sorter. When unspecified, ascending order is implied.

Arrangement for the arrangement_distance sorter

Boolean specifying the sort direction for the max_guests sorter. When unspecified, ascending order is implied.

Boolean specifying the sort direction for the highlighted sorter. When unspecified, ascending order is implied.

Boolean specifying the sort direction for the all_in_amount sorter. When unspecified, ascending order is implied.

Boolean specifying the sort direction for the amenity_ids_match_score sorter. When unspecified, ascending order is implied.

Amenity IDs for the amenity_ids_match_score sorter

Boolean specifying the sort direction for the avg_score sorter. When unspecified, ascending order is implied.

Specify a limiter here. There are 6 different limiters:

• availabilities Return limit availabilities
• start_dates Limit to the limit best arrival dates
• los Limit to the limit best Length of stay (LOS) values
• categories Limit to the limit best types. DEPRECATED: use rentable_types instead.
• rentable_types Limit to the limit best types
• administrations Limit to the limit best administrations

Configuration for the chosen limiter (for example the number of availabilities to return) must be passed separately, see the options below.

Return limit availabilities

Limit to the limit best arrival dates

Number of availabilities to return

Limit to the limit best Length of stay (LOS) values

Number of availabilities to return

Limit to the limit best types. DEPRECATED: use rentable_types instead.

Result offset for the categories limiter, useful for pagination

Number of availabilities to return

Limit to the limit best types

Result offset for the rentable_types limiter, useful for pagination

Number of availabilities to return

Limit to the limit best administrations

Limit to the limit best types. DEPRECATED: use limiter[administrations][rentable_types] instead.

Limit to the limit best types

Number of availabilities to return

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