v1

latestOpenAPI 3.0.02026-07-243271291.7 MB
Categories

GET categories

Deprecated, see rentable_types

get/v3/administrations/{administration_id}/categories

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

fields[category]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[description]string

Filter on description

filter[short_description]string

Filter on short_description

filter[additional_house_rules]string

Filter on additional_house_rules

filter[invoice_details]string

Filter on invoice_details

filter[usps]string

Filter on usps

filter[highlight_priority]string

Filter on highlight_priority

filter[reference]string

Filter on reference

filter[original_identifier]string

Filter on original_identifier

filter[registration_number]string

Filter on registration_number

filter[additional_registration_number]string

Filter on additional_registration_number

filter[minimum_number_of_nights]string

Filter on minimum_number_of_nights

filter[maximum_number_of_nights]string

Filter on maximum_number_of_nights

filter[number_of_bedrooms]string

Filter on number_of_bedrooms

filter[number_of_beds]string

Filter on number_of_beds

filter[number_of_showers]string

Filter on number_of_showers

filter[number_of_toilets]string

Filter on number_of_toilets

filter[number_of_bathrooms]string

Filter on number_of_bathrooms

filter[number_of_parking_spots]string

Filter on number_of_parking_spots

filter[number_of_child_beds]string

Filter on number_of_child_beds

filter[number_of_child_chairs]string

Filter on number_of_child_chairs

filter[surface_area]string

Filter on surface_area

filter[summer_video_id]string

Filter on summer_video_id

filter[winter_video_id]string

Filter on winter_video_id

filter[whole_year_video_id]string

Filter on whole_year_video_id

filter[same_day_bookings_allowed]string

Filter on same_day_bookings_allowed

filter[archived]string

Filter on archived

filter[max_number_of_people]string

Filter on max_number_of_people

filter[highlighted_amenity_ids]string

Filter on highlighted_amenity_ids

filter[prices_updated_at]string

Filter on prices_updated_at

filter[prices_indexed_at]string

Filter on prices_indexed_at

filter[stock_updated_at]string

Filter on stock_updated_at

filter[stock_indexed_at]string

Filter on stock_indexed_at

filter[costs_updated_at]string

Filter on costs_updated_at

filter[extras_updated_at]string

Filter on extras_updated_at

filter[bookable_discounts_changed_at]string

Filter on bookable_discounts_changed_at

filter[agreements_changed_at]string

Filter on agreements_changed_at

filter[last_date_with_price]string

Filter on last_date_with_price

filter[city]string

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

filter[region]string

Filter on region

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[terms]string

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

filter[rentable_segment]string

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

filter[master_price_list]string

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

filter[guest_group_limits]string

Filter on guest_group_limits. 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[rent_earned_ledger_account]string

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

filter[checkin_timetable]string

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

filter[checkout_timetable]string

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

filter[images]string

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

filter[rooms]string

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

filter[rentable_type_amenities]string

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

filter[optional_amenities]string

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

filter[attachments]string

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

filter[accommodation_type]string

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

filter[category_amenities]string

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

include_archivedboolean

When true, archived types 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

CategoryCollectionResponse