Get the match score between an Employee and a Job Family
curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{employee_external_id}/job_families/{job_family_external_id}/match \
  --header 'Authorization: Bearer <token>'
{
  "job_family_id": "b003505-eb84-42dc-a79f-5e7b1fe897b7",
  "employee_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "score": 0.87657
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
employee_external_id
string<uuid>
required

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

Required string length: 1 - 100
Example:

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

​
job_family_external_id
string<uuid>
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

OK

A match result between an Employee and a Job Family.

​
job_family_id
string<uuid>
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"

​
employee_id
string<uuid>
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"

​
score
number
required

The matching score between an Employee and a Job Family, expressed as a number between 0 and 1.

Required range: 0 <= x <= 1
Example:

0.87657