v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

Rentables

GET rentables

Returns rentables of the administration

get/v3/administrations/{administration_id}/rentables

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[rentable]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[active_from]string

Filter on active_from

filter[active_till]string

Filter on active_till

filter[pets_allowed]string

Filter on pets_allowed

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[rentable_amenities]string

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

activeboolean

When true, only active rentables will be returned

include_archivedboolean

When true, rentables of archived inventory objects 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

RentableCollectionResponse