v1

latestOpenAPI 3.0.02026-07-243271291.7 MB

Contractors

GET contractors

Returns contractors of the administration

get/v3/administrations/{administration_id}/contractors

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[contractor]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[title]string

Filter on title

filter[name]string

Filter on name

filter[first_name]string

Filter on first_name

filter[last_name]string

Filter on last_name

filter[email]string

Filter on email

filter[phone]string

Filter on phone

filter[mobile_phone]string

Filter on mobile_phone

filter[locale]string

Filter on locale

filter[rentable_identities]string

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

filter[inventory_objects]string

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

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

ContractorCollectionResponse