Skip to main content

Standardize a Title

GET https://api.truework.com/job-titles/standardize/?input_title=<input_title>

The title standardization endpoint is used to standardize an input job title via the Truework Titles Taxonomy. The endpoint will respond with your standardized title as well as metadata about your request.

curl 'https://api.truework.com/job-titles/standardize/?input_title=data+scientist' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken'

Request#

Query Parameters#

PARAMETERTYPEREQUIREDDEFAULTDESCRIPTION
input_titlestring
Job title to be standardized

Response#

PROPERTYTYPENULLABLEDESCRIPTION
metaTitlesMetaMetadata on the titles taxonomy
inputStandardizationInputThe user provided input
successbooleantrue if the taxonomy successfully standardized the input title.
resultsStandardizationResult[]
List of standardized titles with confidences. Only present if success is true.

TitlesMeta#

PROPERTYTYPENULLABLEDESCRIPTION
versionstringThe version of the Truework Titles Taxonomy being used to process the input

StandarizationInput#

PROPERTYTYPENULLABLEDESCRIPTION
titlestringThe input title provided by the user to the endpoint

StandardizationResult#

PROPERTYTYPENULLABLEDESCRIPTION
standardized_titleStandardizedTitlethe standardized title found in the taxonomy
confidencenumberConfidence score of the standardized title [0, 1]

StandardizedTitle#

PROPERTYTYPENULLABLEDESCRIPTION
idintid of the StandardizedTitle
namestringThe name of the StandardizedTitle
title_family_idintthe id of the TitleFamily this StandardizedTitle belongs to
title_function_idintthe id of the Function this Title belongs to