--- title: "GET customers" method: GET path: "/v3/administrations/{administration_id}/customers" tags: ["Customers"] --- # GET customers `GET /v3/administrations/{administration_id}/customers` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/customers` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns all customers of the administration ## Path parameters - `administration_id` string, required ## Query parameters - `page[number]` integer - `page[size]` integer - `sort` string - `fields[customer]` string - `include` string - `filter[id]` string - `filter[receive_newsletter]` string - `filter[title]` string - `filter[first_name]` string - `filter[last_name]` string - `filter[phone]` string - `filter[email]` string - `filter[is_company]` string - `filter[company]` string - `filter[vat_nr]` string - `filter[business_registration_number]` string - `filter[date_of_birth]` string - `filter[postalcode]` string - `filter[city]` string - `filter[country_code]` string - `filter[locale]` string - `filter[created_at]` string - `filter[updated_at]` string - `filter[labels]` string ## Headers - `Accept-Language` string ## Response `200` CustomerCollectionResponse - object - `data` Customer[] - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `receive_newsletter` boolean - `title` 'mr' | 'ms' | 'family' | 'mrs' | 'miss' | 'mx' | 'dr' | 'prof' | 'rev' | 'sir' | 'dame' | 'lord' | 'lady': The title by which the customer should be addressed. May be left blank. - `first_name` string - `last_name` string - `phone` string - `email` string - `is_company` boolean - `company` string - `vat_nr` string - `business_registration_number` string - `date_of_birth` string, date - `gender` 'male' | 'female' | 'other' | 'prefer_not_to_say' - `address` string - `number` string - `postalcode` string - `city` string - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'AN' | 'ZZ' | 'WW' - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Is used for communication. - `debtor_code` string: DEPRECATED Use the debtor_codes instead - `debtor_codes` string[]: The Debtor Codes this customer has within the organization. - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `labels` object - `data` object[] - `id` string: labels ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` Label[] - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `background` string: The background color of the label. The foreground color is automatically determined when the label is saved. - `foreground` string: The foreground color of the label. This color is automatically determined based on the background color when updating or creating the label. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `meta` object - `pagination` object - `total_records` integer - `page` integer - `size` integer ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 3 warning, 2 info - added the new `da-DK` enum value to the `data/items/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `data/items/attributes/locale` response property for the response status `200` - added the new `en-US` enum value to the `data/items/attributes/locale` response property for the response status `200` - added the optional property `data/items/attributes/debtor_codes` to the response with the `200` status - …1 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/administrations/:administration_id/customers/get.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)