Skip to main content
Get Job

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

job_external_id
string
required

The unique Job ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Query Parameters

include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options:
custom_properties,
job_description
Example:

Response

OK

Default structure for Job.

external_id
string<uuid>
required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Pattern: [a-zA-Z0-9_-]+
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

job_name
string
required

Name of the Job.

Required string length: 1 - 255
Example:

"Front End Developer"

last_updated
string<date-time>
required

Timestamp of the last update to this entity.

Example:

"2021-01-21T17:32:28Z"

job_family_id
string

ID of the Job Family.

Required string length: 1 - 100
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

active
boolean | null
default:true

The Job will not be used in matching if active is false. This is useful when a Job is being phased out.

Example:

true

low_data_availability
boolean

Flag indicating whether sufficient data is available for qualitative Skill inference for a given entity.

Example:

false

custom_properties
object[]

A list of properties for a given entity. Property values are either strings or numbers.

Example:
job_description
string

Description of the Job.

Example:

"The Front-End Developer is responsible for implementing visual elements that users interact with on the company's web applications."