Get Job - TechWolf Developer Portal

API Documentation

API Versioning

Taxonomy

Domains
Subdomains
Skill Clusters
Skills
Taxonomy operations

Employees

CRUD
Skill Profile
Metrics
Search
Skill Events
Interactions
Suggestions

Job Families

CRUD
Skill Profile
Job Family Profile Data

Jobs

Peer Groups

Peer Groups

Vacancies

CRUD
Skill Profile
Metrics
Search

Courses

CRUD
Skill Profile
Metrics

Skill Clusters

CRUD
Skill Profile
Metrics

External Companies

CRUD
Search

Skills

Skill Search
Skill Gaps
Skill Lookup

Organisational Structure

Organisational Units

Custom Properties

Definitions
Properties

Matchmaking

Vacancy Matching
Course Recommendations
External Company Matching
Job Matching
Job Family Matching
Match Feedback

Matching Configuration

Filters

Export

Employees
Job Architecture
Courses
Employees Assigned Position
Taxonomy
Organisational Structure

Reports

General Reports
Employee Reports
Vacancy Reports
Job Reports
Data Maturity Scan

Version

Version

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/jobs/{job_external_id} \
  --header 'Authorization: Bearer <token>'

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "job_family_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "job_name": "Front End Developer",
  "active": true,
  "low_data_availability": false,
  "last_updated": "2021-01-21T17:32:28Z"
}

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

Example:

["custom_properties"]

Response

200

application/json

Default structure for Job.

external_id

string

required

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

Required string length: 1 - 100

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

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

Default structure for Job.

external_id

string

required

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

Required string length: 1 - 100

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

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

Default structure for Job.

external_id

string

required

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

Required string length: 1 - 100

Example:

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

job_name

string

required

Name of the Job.

Required string length: 1 - 255

Example:

"Front End Developer"

custom_properties

object[]

required

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

Example:

[
  {
    "property_name": "creation_date",
    "property_value": "2020-03-07"
  },
  {
    "property_name": "language",
    "property_value": "de"
  }
]

last_updated

string

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

Was this page helpful?

Create Job Update Job

curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/jobs/{job_external_id} \
  --header 'Authorization: Bearer <token>'

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "job_family_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "job_name": "Front End Developer",
  "active": true,
  "low_data_availability": false,
  "last_updated": "2021-01-21T17:32:28Z"
}