v1

latestOpenAPI 3.0.02026-07-243271291.7 MB
Customers

GET customers

Returns all customers of the administration

get/v3/administrations/{administration_id}/customers

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[customer]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[receive_newsletter]string

Filter on receive_newsletter

filter[title]string

Filter on title

filter[first_name]string

Filter on first_name

filter[last_name]string

Filter on last_name

filter[phone]string

Filter on phone

filter[email]string

Filter on email

filter[is_company]string

Filter on is_company

filter[company]string

Filter on company

filter[vat_nr]string

Filter on vat_nr

filter[business_registration_number]string

Filter on business_registration_number

filter[date_of_birth]string

Filter on date_of_birth

filter[postalcode]string

Filter on postalcode

filter[city]string

Filter on city

filter[country_code]string

Filter on country_code

filter[locale]string

Filter on locale

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[labels]string

Filter on labels. 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

CustomerCollectionResponse