Search job benefits
GET
/api/v1.1/{country_code}/search/benefitsAllows searching our job benefits taxonomy for benefits matching a given search term q
.
Example uses for this data include creating a searching for a specific benefit 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
An array of job benefits that match the given search term.
array of:
id
integer
required
The unique ID of the job benefit.
>= -2147483648<= 2147483647
name
string
required
The name of the job benefit.
<= 45 characters
Example
[
{
"id": 1,
"label": "Pension Scheme"
}
]
Last modified: 6 months ago