Reference - Job Title Enrichment API
Reference information for the Job Title Enrichment API
Endpoint
The endpoint for the Job Title Enrichment API is v5/job_title/enrich.
Billing and Access
This API is currently in production, and you can access it by using your API key.
The HTTP response code will be 200 when the API returns a matching job title and 404 when the API neither finds nor returns a matching job title. We charge per match.
Rate Limiting
Our default limit for free customers is 100 per minute. Our default limit for paying customers is 5,000 per minute.
Input Parameters
For More Details, See Job Title Enrichment API - Input Parameters
You can also click on the individual parameter names in the table below to view more information on them.
| Parameter Name | Required | Description | Default | Example |
|---|---|---|---|---|
job_title | Yes | The job title that you are enriching. | None | pastry chef |
api_key | No* | Your secret API key. While we do not require this as part of the request parameters, if you do not provide it here, then you must provide it using an alternative means, such as in the headers using the x-api-key field. For more information, see the Authentication page. | None | |
pretty | No | Whether the output should have human-readable indentation. | false | true |
titlecase | No | All text in the API responses returns as lowercase by default. Setting titlecase to true will titlecase the text in 200 responses. | false | true |
Output Response
Response Fields
For More Details, See Job Title Enrichment API - Output Response.
You can also click the field names in the table below to view more information on them.
| Field Name | Type | Description |
|---|---|---|
cleaned_job_title | String | The job title that matches the API input job_title after passing it through our internal job title cleaner. |
similar_job_titles | Array (String) | A list of up to five of the most contextually-similar job titles to the cleaned_job_title, determined using our global resume data.. |
relevant_skills | Array (String) | A list of up to five of the most contextually-similar skills to the cleaned_job_title, determined using our global resume data. |
Full Example Response
Input Query (click to toggle)
import requests
url = "https://api.peopledatalabs.com/v5/job_title/enrich"
query_string = {"job_title": "supply manager"}
headers = {
'accept': "application/json",
'content-type': "application/json",
'x-api-key': "YOUR_API_KEY"
}
response = requests.request("GET", url, headers=headers, params=query_string)
print(response.text)
Output Response (full):
{
"cleaned_job_title": "supply manager",
"similar_job_titles": [
"senior supply manager",
"supply chain manager",
"supply specialist",
"supply supervisor",
"supply coordinator"
],
"relevant_skills": [
"supply management",
"spend analysis",
"supplier development",
"demand planning",
"strategic sourcing"
]
}
Updated 4 months ago