Skip to main content

Job Title Utilities

info

For more information on the terminology and concepts used here, please visit our blogpost on our Job Title Classification System.

note

When we make backwards-incompatible changes to the Titles API, we release new dated versions. All requests will utilize the latest version.

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_titlestringJob 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

Get a Title#

GET https://api.truework.com/job-titles/title/{id}

The title detail endpoint is used to get more details about a specific Title.

curl 'https://api.truework.com/job-titles/title/{id}' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken'

Response#

Response Body#

PROPERTYTYPENULLABLEDESCRIPTION
metaTitlesMetaMetadata on the titles taxonomy
titleTitleStandardized job title

TitlesMeta#

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

Title#

PROPERTYTYPENULLABLEDESCRIPTION
idintthe identifier of the found Title
namestringthe standard name of the found Title
title_family_idintThe id of the Title Family to which the Title belongs
function_idintThe id of the Function to which the Title belongs.
responsibility_termsstring[]The term or terms in the title which contribute to the Responsibility Facet.
seniority_termsstring[]The term or terms in the title which contribute to the Seniority Facet.
functionality_termsstring[]The term or terms in the title which contribute to the Functionality Facet.

Get a Title Family#

GET https://api.truework.com/job-titles/title-family/{id}

The title detail endpoint is used to get more details about a specific Title Family.

curl 'https://api.truework.com/job-titles/title-family/{id}' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken'

Response#

Response Body#

PROPERTYTYPENULLABLEDESCRIPTION
metaTitlesMetaMetadata on the titles taxonomy
title_familyTitleFamilyStandardized job title family

TitlesMeta#

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

TitleFamily#

PROPERTYTYPENULLABLEDESCRIPTION
idintThe identifier of the Title Family
namestringThe name of the Title Family
function_idintThe id of the Function to which the Title Family belongs

Get Function Details#

curl 'https://api.truework.com/job-titles/function/{id}' \
-X GET \
-H 'Authorization: Bearer myTrueworkToken'

GET https://api.truework.com/job-titles/function/{id}

The title detail endpoint is used to get more details about a specific Function.

Response#

Response Body#

PROPERTYTYPENULLABLEDESCRIPTION
metaTitlesMetaMetadata on the titles taxonomy
functionFunctionStandardized job function

TitlesMeta#

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

Function#

PROPERTYTYPENULLABLEDESCRIPTION
idintThe identifier of the Function
namestringThe name of the Function