Export Employee Skill Profile data

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/export/employees/skill_profiles \
  --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
    }
  ],
  "include": [
    "skill_validation_state",
    "sources",
    "rejected_skills",
    "low_data_availability_flag"
  ],
  "output_skills_sorting": "alphabetical"
}
'

{
  "has_next": true,
  "records": [
    {
      "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
      "num_skill_events": 2,
      "low_data_availability": false,
      "seniority": 4.290482248178559,
      "skills": [
        {
          "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
          "skill": "Python",
          "validation_state": "suggested",
          "sources": [
            "education_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "education_history",
              "source": "workday"
            }
          ],
          "self_rated_proficiency_level": 2,
          "self_rated_proficiency_float": 0.4,
          "inferred_proficiency_level": 5,
          "inferred_proficiency_float": 1
        },
        {
          "skill_id": "267d511f-26d4-4c84-b2ae-eae89627deba",
          "skill": "Unit Testing",
          "validation_state": "suggested",
          "sources": [
            "working_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "working_history",
              "source": "workday"
            }
          ],
          "self_rated_proficiency_level": 2,
          "self_rated_proficiency_float": 0.4,
          "inferred_proficiency_level": 3,
          "inferred_proficiency_float": 0.6
        }
      ]
    }
  ],
  "next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120007"
}

POST

export

employees

skill_profiles

Export Employee Skill Profile data

curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/export/employees/skill_profiles \
  --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
    }
  ],
  "include": [
    "skill_validation_state",
    "sources",
    "rejected_skills",
    "low_data_availability_flag"
  ],
  "output_skills_sorting": "alphabetical"
}
'

{
  "has_next": true,
  "records": [
    {
      "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
      "num_skill_events": 2,
      "low_data_availability": false,
      "seniority": 4.290482248178559,
      "skills": [
        {
          "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
          "skill": "Python",
          "validation_state": "suggested",
          "sources": [
            "education_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "education_history",
              "source": "workday"
            }
          ],
          "self_rated_proficiency_level": 2,
          "self_rated_proficiency_float": 0.4,
          "inferred_proficiency_level": 5,
          "inferred_proficiency_float": 1
        },
        {
          "skill_id": "267d511f-26d4-4c84-b2ae-eae89627deba",
          "skill": "Unit Testing",
          "validation_state": "suggested",
          "sources": [
            "working_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "working_history",
              "source": "workday"
            }
          ],
          "self_rated_proficiency_level": 2,
          "self_rated_proficiency_float": 0.4,
          "inferred_proficiency_level": 3,
          "inferred_proficiency_float": 0.6
        }
      ]
    }
  ],
  "next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120007"
}

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:list

Defines the format of the returned Skill Profile.

Available options:

list,

hierarchy

Example:

"list"

external_vendor

enum<string>

The external vendor vocabulary you want to see the Skills displayed in. This will only work for vendors that are activated on your tenant.

Available options:

workday,

sap_attribute_library

Example:

"workday"

Body

application/json

limit

integer

required

The number of Employees shown 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 string length: 100

Example:

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

filters

(is_active · object | last_updated · object)[]

A set of filters to apply on the exported Employees.

is_active
last_updated

Show child attributes

filters.filter

enum<string>

required

Only include entities with the active attribute set to true or false. If the filter is not set, all entities will be included.

Available options:

is_active

Example:

"is_active"

filters.is_active

boolean

required

Set to true to only include entities with the active attribute set to true. Set to false to only include entities with the active attribute set to false.

Example:

true

include

enum<string>[]

Expand the results with extra data.

Include:

sources - Show the event type sources that led to this Skill Cluster.
seniority - Show the seniority of the Employee.
rejected_skills - Show Skills that got rejected through Skill Profile feedback.
low_data_availability_flag - Show whether there is low data availability for each Employee.
self_rated_proficiency_level - Show the self-rated proficiency level of each Skill in each Employee's profile. This value depends on the maximum proficiency level set on your tenant (default levels are 1-5). If the self-rated proficiency level is not set, null is returned.
self_rated_proficiency_float - Show the self-rated proficiency float of each Skill in each Employee's profile. This value represents the self-rated proficiency level of the Skill, scaled to a range between between 0.0 and 1.0. If the self-rated proficiency level is not set, null is returned.
inferred_proficiency_level - Show the inferred proficiency level of each Skill in each Employee's profile. This value depends on the maximum proficiency level set on your tenant (default levels are 1-5). If the self-rated proficiency level is not set, null is returned.
inferred_proficiency_float - Show the inferred proficiency float of each Skill in each Employee's profile. This value represents the inferred proficiency level of the Skill, scaled to a range between between 0.0 and 1.0. If the inferred proficiency level is not set, null is returned.
properties - Show the skill information properties of each Skill.

Available options:

skill_validation_state,

sources,

rejected_skills,

low_data_availability_flag,

self_rated_proficiency_level,

self_rated_proficiency_float,

inferred_proficiency_level,

inferred_proficiency_float,

properties

Example:

[
  "skill_validation_state",
  "sources",
  "rejected_skills",
  "low_data_availability_flag"
]

output_skills_sorting

enum<string>

default:alphabetical

Sort the Skills in the results alphabetically or by decreasing confidence. This has no effect when an external vendor is specified.

Available options:

alphabetical,

confidence

Example:

"alphabetical"

Response

has_next

boolean

required

True when there is more data after this page.

Example:

true

records

(List · object | Hierarchy · object)[]

required

A list containing the requested data for each entity, limited by the limit parameter.

The default Skill Profile result returned. The profile consists of a list of Skills and their validation states.

List
Hierarchy

Show child attributes

records.external_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"

records.num_skill_events

integer

required

The amount of Skill Events an Employee has.

Required range: x >= 0

Example:

5

records.skills

object[]

required

The Skills contained in this profile.

Show child attributes

records.skills.skill_id

string<uuid>

required

The universally unique ID of the Skill, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this id can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.

Required string length: 1 - 100

Example:

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

records.skills.skill

string

required

The name of the Skill.

Minimum string length: 1

Example:

"Machine Learning"

records.skills.validation_state

enum<string>

required

This field indicates whether this Skill is already validated by a manager or Employee or still in the suggested state.

Available options:

suggested,

validated

Example:

"suggested"

records.skills.sources

string[]

deprecated

The Skill Event types from which the Skill was inferred.

A type of Skill Event.

Example:

["working_history"]

records.skills.source_events

object[]

The Skill Events from which the Skill was inferred.

Show child attributes

records.skills.source_events.external_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"

records.skills.source_events.event_type

string

required

A type of Skill Event.

records.skills.source_events.source

string

required

The source of the Skill Event.

Example:

[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "event_type": "learning",
    "source": "youtube"
  }
]

records.skills.self_rated_proficiency_level

integer<int32> | null

The self-rated proficiency level for this Skill that is associated with the Employee. It cannot be greater than the maximum proficiency level (default levels are 1-5). If the self-rated proficiency level is not set, null is returned. The self-rated proficiency of a suggested Skill will always be null.

Example:

2

records.skills.self_rated_proficiency_float

number<float> | null

The self-rated proficiency (as a float) for this Skill that is associated with the Employee. If the self-rated proficiency is not set, null is returned. The self-rated proficiency of a suggested Skill will always be null.

Required range: 0 < x <= 1

Example:

0.4

records.skills.inferred_proficiency_level

integer<int32> | null

The inferred proficiency level for this Skill that is associated with the Employee. It cannot be greater that the maximum proficiency level (default levels are 1-5). If no inferred proficiency level is available, null is returned.

Example:

3

records.skills.inferred_proficiency_float

number<float> | null

The inferred proficiency (as a float) for this Skill that is associated with the Employee. If no inferred proficiency is available, null is returned.

Required range: 0 < x <= 1

Example:

0.6

records.skills.properties

object

Skill Properties give additional information about the Skill. These properties are the same over all occurrences of the Skill.

Show child attributes

records.skills.properties.sap_status

object

Status of the Skill in the SAP Attribute Library.

Show child attributes

records.skills.properties.sap_status.value

enum<string>

required

Value of the Skill property.

Available options:

active,

inactive

Example:

{ "sap_status": { "value": "active" } }

records.low_data_availability

boolean

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

Example:

false

next_starting_after

string

The next starting_after value for pagination.

Maximum string length: 100

Example:

"5cbdbdbe-5f44-4423-8157-520f8a2f429a"

Export Employee Skill Clusters data.Overview

⌘I

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

Export Employee Skill Profile data

Authorizations

Query Parameters

Body

Response