Use this Restful endpoint to search for companies and return a list of matching results, using the GET method.
Related B2B Restful documentation:
- B2B introduction
- Restful B2B Lookup POST request
- Restful B2B Lookup response
- Restful B2B GetInfo GET request
- Restful B2B Swagger documentation
Restful B2B Lookup GET request
The Lookup endpoint searches for companies and returns a list of matching results.
Endpoint
GET https://{SERVER_ADDRESS}/b2b/lookup?country={COUNTRY_CODE}&companyName={COMPANY_NAME}&zipCode={POSTAL_CODE}&address={ADDRESS}&city={CITY}&filter={FILTER}&limit={LIMIT}Replace the values in braces with your own information.
| Parameter | Description | Mandatory/Optional |
|---|---|---|
| country | ISO 3-letter country code. | Mandatory |
| companyName | Company name or part of the company name. | Mandatory for company-name search |
| zipCode | Postal code or department code. | Optional |
| address | Street type and street name of the business address. | Mandatory for address search |
| city | City name of the business address. | Mandatory for address search |
| filter | Company status filter. Several values can be separated by commas. | Optional. Default value: 1. |
| limit | Maximum number of results to return. | Optional. Default value: 10. |
Filter values
| Value | Description |
|---|---|
1 |
Opened diffusible companies. |
2 |
Closed diffusible companies. |
3 |
Closed old diffusible companies older than 3 years. |
4 |
Non-diffusible companies. |
5 |
RNA records. |
Related to