Search companies
GET
/api/v1.1/{country_code}/search/companiesAllows searching for companies with a name matching a given search term q
.
Example uses for this data include searching for specific companies for use in further requests, or populating a typeahead / autocomplete in a user interface.
Request
Path Params
country_code
string
required
A two character code that specifies which country dataset to query.
Example:
gb
Match pattern:
[a-z]{2}
Query Params
limit
integer
optional
The maximum number of matches to return in a search.
>= 1
Default:
20
q
string
required
The search query.
>= 3 characters
Request samples
Responses
Request successful.(200)
Request successful.
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
array of:
id
integer
required
The unique ID of the company.
>= 1<= 2147483647
Example:
31381
name
string
required
The name of the company.
<= 256 characters
Example:
Adzuna
description
string | null
optional
A description of the company.
country_id
integer
read-onlyrequired
The unique ID of the country in which the company primarily operates.
>= 1<= 2147483647
Example:
1
industry
object (SIC)
required
The industry in which the company operates.
id
string
required
The unique ID of the industry.
<= 1 characters
label
string
required
The name of the industry.
<= 130 characters
description
string
required
A description of the industry.
Example
[
{
"id": 31381,
"name": "Adzuna",
"description": "Adzuna is a next-generation search engine for classified ads used by [...]",
"country_id": 1,
"industry": {
"id": "J",
"label": "Information and communication",
"description": "Information and communication"
}
}
]
Last modified: 4 months ago