Skip to main content
Get the match scores between Employees and their assigned position in bulk.
curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/export/employees/match_assigned_position \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 10,
  "starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
  "filters": [
    {
      "filter": "is_active",
      "is_active": true
    }
  ]
}'
{
  "has_next": true,
  "next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002",
  "records": [
    {
      "job_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.

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"

Body

application/json
​
limit
integer
required

The number of Employees to show on a single page.

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

10

​
starting_after
string

The external_id of the Employee to continue looking from.

Maximum length: 100
Example:

"4cbdbabe-5644-4423-8157-520f8a2f429a"

​
filters
(is_active · object | last_updated · object)[]

A set of filters to apply on the Employees.

  • is_active
  • last_updated

Response

OK

  • Simple
  • Explained
​
has_next
boolean
required

True when there is more data after this page.

Example:

true

​
records
Simple · object[]
required

A list containing the match of each Employee with their assigned position, limited by the limit parameter.

​
next_starting_after
string

The next starting_after value for pagination.

Maximum length: 100
Example:

"61a6e076-d780-11ec-9d64-0242ac120002"

⌘I