Job Matching

Get the match scores between a Job and its market Skill Profiles

We calculate two types of match scores for every Skill Profile in the market, linked to a peer group. More information about external market Skill Profiles can be found in the documentation of the relevant endpoint. The Job to peer score indicates how well the Job Skill Profile covers the Skill requirement of the external market Skill Profile of a certain peer group. The second score is the peer to Job score, which indicates how well the market Skill Profile of a peer group covers the Skill requirements of the Job Skill Profile. The higher the score, the better the match.

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

{
  "job_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "alignment_scores": [
    {
      "peer_group": "B2B",
      "jobn_to_peer_score": 0.85,
      "peer_to_job_score": 0.9
    },
    {
      "peer_group": "B2C",
      "job_to_peer_score": 0.95,
      "peer_to_job_score": 0.8
    }
  ]
}

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

Unique external ID linked to this Job, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Example:

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

Query Parameters

response_format

enum<string>

default:simple

If set to explained, the response will include an explanation of the match.

Available options:

simple,

explained

Example:

"explained"

Response

200

application/json

A match result between a Job and its market Skill Profiles.

Get the match score between an Employee and their assigned position Get the match score between an Employee and a Job

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

{
  "job_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "alignment_scores": [
    {
      "peer_group": "B2B",
      "jobn_to_peer_score": 0.85,
      "peer_to_job_score": 0.9
    },
    {
      "peer_group": "B2C",
      "job_to_peer_score": 0.95,
      "peer_to_job_score": 0.8
    }
  ]
}

API Documentation

API Versioning

Taxonomy

Employees

Job Families

Jobs

Peer Groups

Vacancies

Courses

Skill Clusters

External Companies

Skills

Organisational Structure

Custom Properties

Matchmaking

Matching Configuration

Export

Reports

Version

Get the match scores between a Job and its market Skill Profiles

Authorizations

Path Parameters

Query Parameters

Response