Get customers matching the query parameters.
GET {{baseUrl}}/introducers/customer-search?registration-number=<string>&name=<string>®ion-id=<integer>&street=<string>&city=<string>&postal-code=<string>&locality=<string>&phone=<string>&website=<string>&company-type=<string>&country-code=<string>
This endpoint allows to execute a search query for customer Business Partners and get back search hits that match the query.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
registration-number | string | Company registration number to search for matching customer business partners. | |
name | string | Name to search for matching (company) names of customer business partners. | |
region-id | string | (FR/US only) Region ID to search for matching addresses of customer business partners. | |
street | string | (FR/US only) Street address to search for matching addresses of customer business partners. | |
city | string | City to search for matching addresses of customer business partners. | |
postal-code | string | Postal code to search for matching addresses of customer business partners. | |
locality | string | (GB/ES/Nordics only) Locality to search for matching addresses of customer business partners. | |
phone | string | Phone number to search for matching customer business partners. | |
website | string | (FR/US only) Website to search for matching customer business partners. | |
company-type | string | Finds customers that match a certain company type. | |
country-code | string | (FR/US only) Country code to search for customer business partners. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"businessPartnerRef":{"registrationNumber":"\u003cstring\u003e","sourceCountryCode":"\u003cstring\u003e","companyType":"\u003cstring\u003e"},"name":"sint dolore enim","address1":"sint est sit dolore tempor","address2":"nulla mollit sed","city":"sed aute","postalCode":"fugiat aliqua in sed","countryCode":"officia"},{"businessPartnerRef":{"registrationNumber":"\u003cstring\u003e","sourceCountryCode":"\u003cstring\u003e","companyType":"\u003cstring\u003e"},"name":"in","address1":"labore","address2":"sit et labore irure dolore","city":"aliqui","postalCode":"non in","countryCode":"nostrud et"}]