v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

Owners

GET owners

Returns owners of the administration

get/v3/administrations/{administration_id}/owners

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

fields[owner]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[license_plate_number]string

Filter on license_plate_number

filter[memo]string

Filter on memo

filter[pays_vat]string

Filter on pays_vat

filter[pay_in_advance]string

Filter on pay_in_advance

filter[invoice_from]string

Filter on invoice_from

filter[contract_ends_at]string

Filter on contract_ends_at

filter[psp_recurring_enabled_at]string

Filter on psp_recurring_enabled_at

filter[promotion_token]string

Filter on promotion_token

filter[primary_contact]string

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

filter[contacts]string

Filter on contacts. 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[active_inventory_objects]string

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

filter[owner_guests]string

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

filter[active_rentable_identities]string

Filter on active_rentable_identities. 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[email]string

Filter on email. Only exact matching is supported.

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

OwnerCollectionResponse