Get the Skill Profile for an Employee - TechWolf Developer Portal

API Documentation

API Versioning

Taxonomy

Domains
Subdomains
Skill Clusters
Skills
Taxonomy operations

Employees

CRUD
Skill Profile
- GET
  Get the Skill Profile for an Employee
- PATCH
  Partially update an Employee Skill Profile with feedback
Metrics
Search
Skill Events
Interactions
Suggestions

Job Families

CRUD
Skill Profile
Job Family Profile Data

Jobs

CRUD
Skill Profile
Job Profile Data
Metrics

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/employees/{external_id}/skill_profile \
  --header 'Authorization: Bearer <token>'

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "num_skill_events": 5,
  "low_data_availability": false,
  "skills": [
    {
      "skill": "Machine Learning",
      "skill_id": "c110316a-41d3-46ef-a35e-dbb27785b1c8",
      "validation_state": "suggested",
      "sources": [
        "working_history"
      ],
      "source_events": [
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "working_history",
          "source": "workday"
        }
      ]
    },
    {
      "skill": "Python",
      "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
      "validation_state": "validated",
      "sources": [
        "education_history",
        "working_history"
      ],
      "source_events": [
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "education_history",
          "source": "workday"
        },
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "working_history",
          "source": "workday"
        }
      ]
    },
    {
      "skill": "Tensorflow",
      "skill_id": "e03c1859-3bae-4700-b2c5-ede2937038de",
      "validation_state": "suggested",
      "sources": [
        "education_history"
      ],
      "source_events": [
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "education_history",
          "source": "workday"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

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"

Query Parameters

response_format

enum<string>

default:list

Defines the format of the returned Skill Profile.

Available options:

list,

skill_clusters,

domains,

hierarchy

Example:

"list"

vocab_language

enum<string>

default:en_uk

The display language used for Skill names. Altering the vocabulary language does not change the Skill Profile; it solely changes the way it is displayed. If not specified, the default language (en_uk) will be used. The en language is an alias for en_uk.

Available options:

en,

en_uk,

en_us,

de,

fr,

nl

include

enum<string>[]

Additional entity attributes that will be included in the response body. This parameter

Available options:

sources,

low_data_availability_flag

Example:

["sources"]

external_vendor

enum<string>

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

Available options:

workday

Example:

"workday"

Response

200

application/json

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

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"

num_skill_events

integer

required

The amount of Skill Events an Employee has.

Required range: x >= 0

Example:

5

skills

object[]

required

The Skills contained in this profile.

Structure for an individual Skill with source.

skills.skill_id

string

required

The universal 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"

skills.skill

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

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"

skills.sources

string[]

deprecated

The Skill Event types from which the Skill was inferred.

A type of Skill Event.

Example:

["working_history"]

skills.source_events

object[]

The Skill Events from which the Skill was inferred.

Skill Event information

Example:

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

Example:

[
  {
    "skill": "Machine Learning",
    "skill_id": "c110316a-41d3-46ef-a35e-dbb27785b1c8",
    "validation_state": "suggested",
    "sources": ["working_history"],
    "source_events": [
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "working_history",
        "source": "workday"
      }
    ]
  },
  {
    "skill": "Python",
    "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
    "validation_state": "validated",
    "sources": ["education_history", "working_history"],
    "source_events": [
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "education_history",
        "source": "workday"
      },
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "working_history",
        "source": "workday"
      }
    ]
  },
  {
    "skill": "Tensorflow",
    "skill_id": "e03c1859-3bae-4700-b2c5-ede2937038de",
    "validation_state": "suggested",
    "sources": ["education_history"],
    "source_events": [
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "education_history",
        "source": "workday"
      }
    ]
  }
]

low_data_availability

boolean

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

Example:

false

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

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"

num_skill_events

integer

required

The amount of Skill Events an Employee has.

Required range: x >= 0

Example:

5

skills

object[]

required

The Skills contained in this profile.

Structure for an individual Skill with source.

skills.skill_id

string

required

Required string length: 1 - 100

Example:

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

skills.skill

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

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"

skills.sources

string[]

deprecated

The Skill Event types from which the Skill was inferred.

A type of Skill Event.

Example:

["working_history"]

skills.source_events

object[]

The Skill Events from which the Skill was inferred.

Skill Event information

Example:

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

Example:

[
  {
    "skill": "Machine Learning",
    "skill_id": "c110316a-41d3-46ef-a35e-dbb27785b1c8",
    "validation_state": "suggested",
    "sources": ["working_history"],
    "source_events": [
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "working_history",
        "source": "workday"
      }
    ]
  },
  {
    "skill": "Python",
    "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
    "validation_state": "validated",
    "sources": ["education_history", "working_history"],
    "source_events": [
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "education_history",
        "source": "workday"
      },
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "working_history",
        "source": "workday"
      }
    ]
  },
  {
    "skill": "Tensorflow",
    "skill_id": "e03c1859-3bae-4700-b2c5-ede2937038de",
    "validation_state": "suggested",
    "sources": ["education_history"],
    "source_events": [
      {
        "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
        "event_type": "education_history",
        "source": "workday"
      }
    ]
  }
]

low_data_availability

boolean

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

Example:

false

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

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"

num_skill_events

integer

required

The amount of Skill Events an Employee has.

Required range: x >= 0

Example:

5

skills

object[]

required

The Skills contained in this profile.

Structure for an individual Skill with sources.

skills.skill

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

skills.skill_id

string

required

The universal unique ID of the Skill, consisting of alphanumeric characters, hyphens and underscores. The format of this ID will differ from vendor to vendor.

Required string length: 1 - 100

Example:

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

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"

skills.source_events

object[]

The Skill Events from which the Skill was inferred.

Skill Event information

Example:

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

Example:

[
  {
    "skill": "Machine Learning",
    "skill_id": "111-AAA",
    "validation_state": "suggested"
  },
  {
    "skill": "Python",
    "skill_id": "111-BBB",
    "validation_state": "validated"
  },
  {
    "skill": "Tensorflow",
    "skill_id": "111-CCC",
    "validation_state": "suggested"
  }
]

low_data_availability

boolean

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

Example:

false

The Skill Profile in Skill Cluster format. The profile consists of a list of Skill Clusters with scores, with each score representing the importance of the Skill Cluster at hand.

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"

num_skill_events

integer

required

The amount of Skill Events an Employee has.

Required range: x >= 0

Example:

5

skill_clusters

object[]

required

The Skill Clusters contained in this profile, along with their proficiency levels.

skill_clusters.skill_cluster_id

string

required

ID of the Skill Cluster.

skill_clusters.skill_cluster_name

string

required

Name of the Skill Cluster.

skill_clusters.domain_name

string

required

The name of the Domain associated with this Skill Cluster.

skill_clusters.proficiency_level

integer

required

Proficiency level of the entity in this Skill Cluster.

Required range: 0 <= x <= 3

skill_clusters.validation_state

enum<string>

required

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

Available options:

validated,

suggested

skill_clusters.subdomain_name

string

The name of the Subdomain associated with this Skill Cluster. This field is only applicable in a 4-level Taxonomy.

skill_clusters.current_skills

object[]

The Skills of the Skill Cluster that are also in the Skills of the entity.

Default structure for an individual Skill.

skill_clusters.current_skills.skill_name

string

required

The name of the Skill.

Minimum length: 1

Example:

"Machine Learning"

skill_clusters.current_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"

skill_clusters.current_skills.skill_id

string

required

Required string length: 1 - 100

Example:

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

skill_clusters.current_skills.skill_sources

string[]

deprecated

The Skill Event types from which the Skill was inferred.

A type of Skill Event.

Example:

["working_history"]

skill_clusters.sources

string[]

deprecated

The Skill Event types from which the Skills were inferred in the Skill Cluster.

A type of Skill Event.

Example:

["working_history"]

Example:

[
  {
    "skill_cluster_id": "f074ea9e-5431-4e8d-992e-2abe21868b45",
    "skill_cluster_name": "Programming Languages",
    "domain_name": "Computer Science",
    "proficiency_level": 2,
    "validation_state": "suggested",
    "current_skills": [
      {
        "skill_name": "Python",
        "validation_state": "suggested",
        "skill_id": "4dba81ae-9a4d-4863-8157-520f8a2f4c59",
        "skill_sources": ["working_history"]
      },
      {
        "skill_name": "Java",
        "validation_state": "suggested",
        "skill_id": "15aa59ae-9a4d-4863-8157-520f8a2f4e64",
        "skill_sources": ["working_history", "skill_profile_feedback"]
      }
    ],
    "sources": ["working_history", "skill_profile_feedback"]
  },
  {
    "skill_cluster_id": "24180a01-f202-4c43-8a79-0721a1d46ec2",
    "skill_cluster_name": "DevOps",
    "domain_name": "Computer Science",
    "proficiency_level": 3,
    "validation_state": "validated",
    "current_skills": [
      {
        "skill_name": "GitLab",
        "validation_state": "suggested",
        "skill_id": "72dec06b-8614-4930-b296-d7596fd9fd7b",
        "skill_sources": ["working_history"]
      },
      {
        "skill_name": "Jenkins",
        "validation_state": "suggested",
        "skill_id": "eebcf485-9045-4669-a6f7-6e7faa465ff9",
        "skill_sources": ["working_history"]
      },
      {
        "skill_name": "Kubernetes",
        "validation_state": "validated",
        "skill_id": "94835c7e-4135-40d7-aea6-165b33d01589",
        "skill_sources": ["education_history"]
      }
    ],
    "sources": ["education_history", "working_history"]
  }
]

low_data_availability

boolean

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

Example:

false

The Skill Profile in Domain format. The profile consists of a list of domains with the Skills belonging to them, and a percentage representing the size of the share of the Skill Profile the Domain represents.

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"

num_skill_events

integer

required

The amount of Skill Events an Employee has.

Required range: x >= 0

Example:

5

domains

object[]

required

The Domains contained in this profile along with the Skills belonging to them, and a percentage representing the size of the share of the Skill Profile the Domain represents.

domains.name

string

required

The name of the Domain.

Minimum length: 1

Example:

"Computer Science"

domains.percentage

number

required

The size of the share of the entire Skill Profile that the Domain represents.

Required range: 0 <= x <= 1

Example:

0.75

domains.skills

string[]

required

The list of Skills from the Skill Profile belonging to the corresponding Domain.

Example:

["Python", "Java", "Programming"]

domains.skill_dicts

object[]

The list of Skills from the Skill Profile belonging to the corresponding Domain.

A Skill in the Domain.

Example:

[
  {
    "skill_name": "Python",
    "uuid": "6b819e9c-f276-41fc-829b-fffcb848b1a9"
  }
]

Example:

[
  {
    "name": "Computer Science",
    "percentage": 0.75,
    "skills": ["Python", "Java", "Programming"],
    "skill_dicts": [
      {
        "skill_name": "Python",
        "uuid": "6b819e9c-f276-41fc-829b-fffcb848b1a9"
      },
      {
        "skill_name": "Java",
        "uuid": "6b819e9c-f276-41fc-829b-fffcb848b1a9"
      },
      {
        "skill_name": "Programming",
        "uuid": "6b819e9c-f276-41fc-829b-fffcb848b1a9"
      }
    ]
  },
  {
    "name": "Interpersonal Skills",
    "percentage": 0.25,
    "skills": ["Presenting to management"],
    "skill_dicts": [
      {
        "skill_name": "Presenting to management",
        "uuid": "6b819e9c-f276-41fc-829b-fffcb848b1a9"
      }
    ]
  }
]

The response format formats the Skills in a hierarchical structure. When a Taxonomy is availabe it contains Domains, Skill Clusters and Skills. If it is a 4-level Taxonomy, there is a Subdomain layer between Domains and Skill Clusters. If no Taxonomy is available, the Skills are grouped under their default Techwolf Domain.

domains

object[]

required

Domains of the Skills in the Skill Profile. If no Taxonomy is avaiable, these are the Techwolf Domains.

skills_outside_taxonomy

object[]

List of Skills that are outside of the Taxonomy. This field is only present when a Taxonomy is available.

Default structure for an individual Skill.

Was this page helpful?

Delete Employee Partially update an Employee Skill Profile with feedback

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

{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "num_skill_events": 5,
  "low_data_availability": false,
  "skills": [
    {
      "skill": "Machine Learning",
      "skill_id": "c110316a-41d3-46ef-a35e-dbb27785b1c8",
      "validation_state": "suggested",
      "sources": [
        "working_history"
      ],
      "source_events": [
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "working_history",
          "source": "workday"
        }
      ]
    },
    {
      "skill": "Python",
      "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
      "validation_state": "validated",
      "sources": [
        "education_history",
        "working_history"
      ],
      "source_events": [
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "education_history",
          "source": "workday"
        },
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "working_history",
          "source": "workday"
        }
      ]
    },
    {
      "skill": "Tensorflow",
      "skill_id": "e03c1859-3bae-4700-b2c5-ede2937038de",
      "validation_state": "suggested",
      "sources": [
        "education_history"
      ],
      "source_events": [
        {
          "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
          "event_type": "education_history",
          "source": "workday"
        }
      ]
    }
  ]
}