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 users can access it using their API key.

When a matching job title is returned, the HTTP response code will be 200, and when no matching job title is found or returned, the HTTP response code will be a 404. We charge per match.

Rate Limiting

Our default limit for free customers is 100/min. Our default limit for paying customers is 5000/min.

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.

Parameter Name

Required

Description

Default

Example

job_title

Yes

The job title that you are enriching.

None

pastry chef

pretty

No

Whether the output should have human-readable indentation.

False

True

api_key

No

Not required as part of the request parameters. But if not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

None

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.

Field Name

Type

Description

cleaned_job_title

String

The job title that matches the API input job_title after it's passed through our internal job title cleaner.

similar_job_titles

Array (String)

A list of up to five other job titles.

relevant_skills

Array (String)

A list of up to five of the most contextually-similar skills to the cleaned_job_title, determined using PDL’s 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"
  ]
}

Did this page help you?