Search industries
GET
/api/v1.1/{country_code}/search/industriesAllows searching our for a specific industry matching a given search term q
.
Example uses for this data include creating a searching for a specific industry 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
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": "A",
"label": "Agriculture, forestry and fishing",
"description": "Agriculture, forestry and fishing"
}
]
Last modified: 5 months ago