Skip to main content
Get suggestions, validated and rejected Skills for selected Employees
curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/suggestions/skills \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "employee_ids": [
    "a3903505-eb84-42dc-a79f-5e7b1fe897b7"
  ],
  "response_format": "skill_profiles"
}'
{
  "suggestions": [
    {
      "employee_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "skills": [
        {
          "skill_id": "95747a9e-57e7-4892-967d-37e6c126e35e",
          "skill_names": [
            {
              "language": "en_uk",
              "skill_name": "Python"
            },
            {
              "language": "nl",
              "skill_name": "Python"
            }
          ],
          "sources": [
            "education_history"
          ],
          "self_rated_proficiency_level": null,
          "is_job_critical_skill": true
        },
        {
          "skill_id": "6b665a95-dba8-4f76-85d7-a4669da01c26",
          "skill_names": [
            {
              "language": "en_uk",
              "skill_name": "Programming"
            },
            {
              "language": "nl",
              "skill_name": "Programmeren"
            }
          ],
          "sources": [
            "education_history"
          ],
          "self_rated_proficiency_level": null,
          "is_job_critical_skill": false
        }
      ]
    }
  ],
  "validated": [
    {
      "employee_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "skills": [
        {
          "skill_id": "81fcc471-cef7-448d-824c-2e2ebf1ce8be",
          "skill_names": [
            {
              "language": "en_uk",
              "skill_name": "Agile Development"
            },
            {
              "language": "nl",
              "skill_name": "Agile Ontwikkeling"
            }
          ],
          "sources": [
            "education_history"
          ]
        },
        {
          "skill_id": "7d34b72e-7ca5-45fd-80e0-8ed7e615ee53",
          "skill_names": [
            {
              "language": "en_uk",
              "skill_name": "Automated Testing"
            },
            {
              "language": "nl",
              "skill_name": "Geautomatiseerd Testen"
            }
          ],
          "sources": [
            "education_history"
          ],
          "self_rated_proficiency_level": 2,
          "is_job_critical_skill": true
        }
      ]
    }
  ],
  "rejected": [
    {
      "employee_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "skills": [
        {
          "skill_id": "6843733c-e646-4a77-ae70-c0da60618ffe",
          "skill_names": [
            {
              "language": "en_uk",
              "skill_name": "Business Requirement Analysis"
            },
            {
              "language": "nl",
              "skill_name": "Analyse Van Bedrijfsvereisten"
            }
          ],
          "self_rated_proficiency_level": null,
          "is_job_critical_skill": false
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
language
enum<string>[]

The display languages for which Skill names are provided. If not specified, the default language (en_uk) will be used. The en language is an alias for en_uk. Languages for which no Skill names are available will be excluded from the response.

​
suggestion_count
integer

The maximum number of suggested Skills to be returned and displayed within each Employee's Skill Profile.

Required range: x >= 1
​
max_skills_per_cluster
integer

The maximum number of Skills to return for each Skill Cluster. This only applies when response_format is set to skill_clusters.

Required range: x >= 1
​
external_vendor
enum<string>

The external vendor vocabulary in which you want the Skill suggestions to be returned. This will only work for vendors that are activated on your tenant. If no external vendor is specified, Skills will be returned in the TechWolf vocabulary.

Available options:
workday,
sap_attribute_library
Example:

"workday"

​
properties
object

Filter skills by their properties. Use the format properties[property_name]=value to filter skills that have a specific property with a specific value. For example, properties[sap_status]=active will only return skills that have the sap_status property set to active.

Available properties:

  • sap_status: Status of the Skill in the SAP Attribute Library (possible values: active, inactive)
​
include
enum<string>[]

The type of Skills to include in the response and which Skill properties to include. suggested_skills - Include the suggested Skills in the response. validated_skills - Include the validated Skills in the response. rejected_skills - Include the rejected Skills in the response. proficiency - Include the self-rated proficiency level for the Skills in the response. job_critical_info - Include whether the Skill is a critical Skill for the Job of the Employee.

Example:
["suggested_skills"]

Body

application/json
​
employee_ids
string<uuid>[]
required

The IDs of the Employees for which to get the suggestions. Maximum of 50 Employees.

Maximum length: 50

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

​
response_format
enum<string>
default:skill_profiles

The format in which the suggestions should be returned. skill_profiles - Return the suggestions as a list of the Employee Skill Profiles. skill_clusters - Return the suggestions as a list of the Employee Skill Clusters. Response format skill_clusters requires a taxonomy with skill clusters to be activated on your tenant.

Available options:
skill_profiles,
skill_clusters

Response

OK

​
suggestions
object[]

An array containing Skill suggestions for the requested Employees.

Example:
[
  {
    "employee_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "skills": [
      {
        "skill_id": "95747a9e-57e7-4892-967d-37e6c126e35e",
        "skill_names": [
          {
            "language": "en_uk",
            "skill_name": "Python"
          },
          { "language": "nl", "skill_name": "Python" }
        ],
        "sources": ["education_history"],
        "self_rated_proficiency_level": null,
        "is_job_critical_skill": true
      },
      {
        "skill_id": "6b665a95-dba8-4f76-85d7-a4669da01c26",
        "skill_names": [
          {
            "language": "en_uk",
            "skill_name": "Programming"
          },
          {
            "language": "nl",
            "skill_name": "Programmeren"
          }
        ],
        "sources": ["education_history"],
        "self_rated_proficiency_level": null,
        "is_job_critical_skill": false
      }
    ]
  }
]
​
validated
object[]

An array containing validated Skill suggestions for the requested Employees.

Example:
[
  {
    "employee_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "skills": [
      {
        "skill_id": "81fcc471-cef7-448d-824c-2e2ebf1ce8be",
        "skill_names": [
          {
            "language": "en_uk",
            "skill_name": "Agile Development"
          },
          {
            "language": "nl",
            "skill_name": "Agile Ontwikkeling"
          }
        ],
        "sources": ["education_history"]
      },
      {
        "skill_id": "7d34b72e-7ca5-45fd-80e0-8ed7e615ee53",
        "skill_names": [
          {
            "language": "en_uk",
            "skill_name": "Automated Testing"
          },
          {
            "language": "nl",
            "skill_name": "Geautomatiseerd Testen"
          }
        ],
        "sources": ["education_history"],
        "self_rated_proficiency_level": 2,
        "is_job_critical_skill": true
      }
    ]
  }
]
​
rejected
object[]

An array containing rejected Skill suggestions for the requested Employees.

Example:
[
  {
    "employee_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "skills": [
      {
        "skill_id": "6843733c-e646-4a77-ae70-c0da60618ffe",
        "skill_names": [
          {
            "language": "en_uk",
            "skill_name": "Business Requirement Analysis"
          },
          {
            "language": "nl",
            "skill_name": "Analyse Van Bedrijfsvereisten"
          }
        ],
        "self_rated_proficiency_level": null,
        "is_job_critical_skill": false
      }
    ]
  }
]