Skill Engine API (2023-09-26)

Download OpenAPI specification:Download

API Support: support@techwolf.ai URL: https://www.techwolf.ai/

The Skill Engine API is your single stop for continuous skill tracking, matching, learning management and strategic insights. This API specification describes how to augment your existing data sources with skills to build your workforce of tomorrow.

Authentication

The Skill Engine API uses OAuth2 for authentication. You'll receive a client_id, client_secret, audience and tenant from TechWolf to request an Authorization token at https://techwolf.eu.auth0.com/oauth/token with grant_type client_credentials.
Authorization tokens are limited and requesting a new token requires an HTTP request to the token endpoint, slowing down requests. So if you're not using a standard OAuth2 client, make sure to cache this token and reuse it until it expires. The expiry is returned by Auth0 (and also encoded in the token). More information about OAuth2 can be found here.

An example request to the token endpoint is as follows:

curl -X POST 'https://techwolf.eu.auth0.com/oauth/token' \
-H 'Accept: application/json'  \
-H 'Content-Type: application/json' \
-d '{"client_id": "abcd12317icwFq2x3f4v4BZlQ2sB5q2i2E",
    "client_secret": "abcd1234JViv17icwFq2x3f4v4BZlQ2sB5q2i2E",
    "audience": "eu3.techwolf.ai",
    "grant_type": "client_credentials",
    "tenant": "company_xyz"}'

The response contains the following attributes:

  • access_token: the token that is to be used in the Authorization header of subsequent API calls
  • expires_in: lifetime of the token
  • scope: access permissions of the token
  • token_type: default Bearer

An example response can be found below:

{
    "access_token": "eyJhbGciOiJSUzI0I0seiEw",
    "expires_in": 10800,
    "scope": "read write"
    "token_type": "Bearer"
}

Scopes

A list of the supported scopes can be found below:

  • read: Grants read access
  • write: Grants write access
  • read_reports: Grants read access to reports (only aggregated info)

You can determine which scopes should be included in your access token by specifying them in the token request. If you don't specificy the scopes, you will receive a token with all possible scopes for your tenant.

curl -X POST 'https://techwolf.eu.auth0.com/oauth/token' \
-H 'Accept: application/json'  \
-H 'Content-Type: application/json' \
-d '{"client_id": "abcd12317icwFq2x3f4v4BZlQ2sB5q2i2E",
    "client_secret": "abcd1234JViv17icwFq2x3f4v4BZlQ2sB5q2i2E",
    "audience": "eu3.techwolf.ai",
    "grant_type": "client_credentials",
    "tenant": "company_xyz",
    "scopes": ["read", "read_reports"]}'

Using the token

The token needs to be added in the Authorization header of the subsequent API calls, in the following format Authorization: Bearer {access_token}. To verify if your token works, you can retrieve the version of your tenant via the /version endpoint:

curl -X GET '[server-url]/version' \
    -H 'Accept: application/json'  \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI0I0seiEw'

Want to Know More? More information about the authentication process with OAuth2 can be found on the Auth0 website.

Versioning Overview

The SkillEngine API is a date-based versioned API system, such that each integrator interacts with a certain version of our product. To know your own version, you can call the version-endpoint (description can be found below).

Your version is set by us at the time your tenant is created. This version controls how your API will behave (in terms of supported parameters, response formats, etc.).

As it is possible that we introduce breaking changes in future updates that may break your code, we will not update your version unless you specifically request this. Breaking changes will always be released under a new date and can be tracked in the documentation below.

Non-breaking changes, on the other hand, will be supported by your API, ** regardless of your version**. An overview can also be found below.

In case you want to test a specific version of the API, e.g. when switching versions, you can add the header X-API-Version to your requests. The value of this header is the version of the API you want to use, for example 2021-03-19 .

Finally, when an endpoint is marked with an Beta tag, this means that it is "in beta" Please note that these endpoints can undergo breaking changes without any notice or promises on backwards compatibility. You should not use them in production.

Compatible Changes

The list below gives a sorted overview of non-breaking changes to the SkillEngine API. These changes are immediately available to you, will be supported by your API, regardless of your version.

View all compatible changes.

September 2023

  • Add skill_description response body field and query parameter include=skill_description to GET taxonomy/export.
  • Add a vacancy data type for Job Profile Data. Available in the POST /job_architecture/jobs/{job_external_id}/profile_data endpoint.
  • Add the taxonomy/changes endpoint to view all changes to the taxonomy within a certain timeframe.
  • Add skill_id and skill_sources to Skills of response body field in GET export/employees/skill_clusters.
  • Add a POST /job_architecture/export/job/skill_clusters endpoint to fetch job skill clusters and skills in bulk.

August 2023

  • Add skill_id response body field and query parameter search_method to POST skills/search.
  • Add GET and POST /taxonomy/domains to see all Domains and create a new Domain respectively. Add GET, PATCH and DELETE /taxonomy/domains/{external_id} to see a single Domain, update a Domain and delete a Domain respectively.
  • Add GET and POST /taxonomy/skill_clusters to see all Skill Clusters and create a new Skill Cluster respectively. Add GET, PATCH and DELETE /taxonomy/skill_clusters/{external_id} to see a single Skill Cluster, update a Skill Cluster and delete a Skill Cluster respectively.
  • Add GET /taxonomy/skill_clusters/{external_id}/skills to see all Skills in a Skill Cluster. Add PUT and DELETE /taxonomy/skill_clusters/{external_id}/skills/{skill_external_id} to add a Skill to a Skill Cluster and remove a Skill from a Skill Cluster respectively.
  • Add GET /taxonomy/skills/{concept_uuid} and GET /taxonomy/skills to get meta information of a single Skill or multiple Skills.
  • Add GET /taxonomy/export to export the full structure of the Taxonomy.
  • Add POST /taxonomy/apply to apply a set of changes to the Taxonomy.
  • Add skill_id to the response body of GET job_architecture/jobs/{job_external_id}/skill_profile and GET job_architecture/job_families/{job_family_external_id}/skill_profile.
  • Add functionality for Jobs to not be linked to a Job Family.
  • Skill profile feedback in skill cluster format (PATCH /employees/{external_id}/skill_profile?feedback_format=skill_clusters) can now be given with a skill_cluster_id.
  • Add GET /job_architecture/export.

July 2023

  • Add POST /reports/job_architecture_benchmark.
  • Add the include=skill_match_scores query parameter to the POST /employees/{external_id}/matching_job_families, which includes match scores between the Employee and individual Skills in the response.

June 2023

  • Add POST /reports/internal_talent_mobility.
  • Update POST /reports/skill_inventory.
  • Add GET /employees/{employee_external_id}/interactions and GET /employees/{employee_external_id}/interactions/{interaction_external_id} endpoints, which allow for listing all interactions of an Employee and getting a single Interaction respectively.
  • Deprecated the PUT /employees/{external_id}/skill_profile, PUT /vacancies/{external_id}/skill_profile, PUT /courses/{external_id}/skill_profile and PUT /occupations/{external_id}/skill_profile endpoints.
  • Add POST /employees/{employee_external_id}/matching_job_families endpoint, which calculates and returns matching Job Families for an Employee. Weights are not customizable, but filtering on custom properties, external IDs and the last_updated field is allowed.
  • Add the used_event_types body parameter to the POST /employees/{employee_id}/matching_vacancies endpoint, allowing to use only events of certain types to be taken into account when calculating matching Vacancies for an Employee.

May 2023

  • Vacancy searching now works based on literal text matching by default. Skills based searching is still possible, as well as a combination of both.
  • Allow PATCH on SkillEvents with type skill_notes.
  • Add progress to the POST /reports/skill_inventory endpoint.
  • Add skill_cluster_id to the output of Employee, Vacancy, Course, Occupation GET /{entity}/{external_id}/skill_profile?response_format=skill_clusters endpoints, the POST /export/employees/skill_clusters endpoint, and the POST /vacancies/{external_id}/matching_employees?include=skill_clusters endpoint.
  • Add POST /employees/{employee_external_id}/interactions and DELETE /employees/{employee_external_id}/interactions/{interaction_external_id} endpoints, which allow the creation and deletion of Interactions between the Employee and a title or Vacancy.
  • Add PATCH /job_architecture/job_families/{job_family_external_id}/skill_profile and PATCH /job_architecture/job/{job_external_id}/skill_profile which allow feedback on the skill profile of Job Families and Jobs respectively.
  • Add a breakdown of the matching vacancies for a company in the results of the /companies/search endpoint.

April 2023

  • Courses can now have a source field. When creating Skill Events from a Course with a source, the source of the Course will be used if no source is provided in the Skill Event.
  • Add POST /reports/skill_inventory endpoint to get the Skill Inventory report.

March 2023

  • Add Update /employees/{employee_external_id}/skill_events/{skill_event_external_id} endpoint to support updating an Employee's Skill Event.
  • Add Job and Job Family entities to job_architecture/jobs and job_architecture/job_families endpoints respectively.
  • Add Job Profile Data and Job Family Profile Data to the job_architecture/job_families/{job_family_external_id}/profile_data and job_architecture/jobs/{job_external_id}/profile_data endpoints respectively.
  • Add custom_property_is_in_list filter to POST employees/{employee_external_id}/recommended_courses.
  • Add the property_value and assigned_position fields of an employee to the Skill Cluster Adoption report (reports/employees/skill_cluster_adoption).
  • Add GET job_architecture/jobs/{job_external_id}/skill_profile and GET job_architecture/job_families/{job_family_external_id}/skill_profile endpoints
  • Add match_feedback option for the include parameter of the /employees/{employee_external_id}/matching_vacancies and /vacancies/{vacancy_external_id}/matching_employees endpoints, which includes feedback given to a match in the result if applicable.
  • Custom Properties have been added to the Job and Job Family entities. They can be requested by using the custom_properties include option when sending to the GET job_architecture/jobs/{job_external_id} and GET job_architecture/job_families/{job_family_external_id} endpoints.
  • Add Update /job_architecture/jobs/{job_external_id}/profile_data/{profile_data_external_id} and Update /job_architecture/job_families/{job_family_external_id}/profile_data/{profile_data_external_id} endpoints to support updating Job Profile Data and Job Family Profile Data.
  • Create or update working history skill events using a job_id at POST /employees/{employee_external_id}/skill_events and PATCH /employees/{employee_external_id}/skill_events/{skill_event_external_id} respectively

February 2023

  • Add the multi_max_geo_distances filter in matching for endpoints /employees/{external_id}/matching_vacancies and /vacancies/{external_id}/matching_employees.
  • Add the Succession Risk Report available under the /reports/succession_risk endpoint.
  • Add the rejected_skills include option to the POST /export/employees/skill_clusters endpoint.
  • Add the option to create learning skill events from a course_id

January 2023

  • Add competency_type in GET /competencies and GET /competencies/{external_id}.
  • Add support for specifying the location in LocationAddress format in the MaxGeoDistanceFilter.
  • Add the Replacement Risk Report available under the /reports/replacement_risk endpoint.

December 2022

  • The Get Skill Profile endpoints /entity_type/{external_id}/skill_profile with response_format=competencies now return skill information.
  • Add custom_property_list_overlap filter for Employee and Vacancy matching.
  • Add GET vacancies/{vacancy_external_id}/metrics/fillability endpoint, which calculates the fillability metric of a Vacancy. The fillability is influenced by the number of matching Employees and the number of Vacancies that can be filled by those Vacancies. More matching Employees will result in a higher fillability, and more matching Vacancies will result in a lower fillability.
  • Add POST vacancies/{vacancy_external_id}/metrics/fillability endpoint which allows for filtering the used entities on maximal allowed distance and custom properties, and assigning weights to the different factors used in the fillability calculation.
  • Add exclude_match_feedback filter to POST employees/{employee_external_id}/recommended_courses and POST employees/{employee_external_id}/matching_vacancies
  • Add DELETE endpoints to employees/{employee_external_id}/vacancies/{vacancy_external_id}/match_feedback and employees/{employee_external_id}/courses/{course_external_id}/match_feedback
  • Add include=competencies query parameter to vacancies/{vacancy_external_id}/matching_employees.
  • Add include query parameter for the employees/{employee_external_id}/similar endpoint. Possible values are: entity, competencies and custom_properties.
  • Add validation_state to skills returned from GET employees/{employee_external_id}/skill_profile endpoint in list and competency format.
  • Add validation_state to skills returned from POST export/employees/competencies endpoint.
  • Add exclude_match_feedback filter to the employees/search and vacancies/search endpoints.
  • Add related_skills to include in POST export/employees/competencies endpoint.
  • Adding a proficiency_level to a competency in the body is no longer required when sending feedback via PUT or PATCH to /employees/{employee_external_id}/skill_profile?feedback_format=competencies
  • Add score_breakdown option for the include parameter of the /employees/{employee_external_id}/matching_vacancies and /vacancies/{vacancy_external_id}/matching_employees endpoints, which includes a breakdown of the contribution of all input weights to the total match score in the response body.

November 2022

  • Add the skill_notes event type.
  • Add the Competency Adoption Report available under the /reports/employees/competency_adoption endpoint.
  • Add POST employees/{employee_external_id}/metrics/employability endpoint which allows for filtering the used entities on maximal allowed distance and custom properties, and assigning weights to the different factors used in the calculation.
  • Add PATCH endpoint to vacancies/{external_id}/skill_profile, occupations/{external_id}/skill_profile and courses/{external_id}/skill_profile.
  • Add include=relevant_experience query parameter to employees/{employee_external_id}/matching_vacancies and vacancies/{vacancy_external_id}/matching_employees.
  • For LocationAddress inputs, city can be used instead of postal_code now, making one of them required instead of having postal_code required.
  • The Get Skill Profile endpoints /entity_type/{ID}/skill_profile with response_format=competencies now return skill category information.

October 2022

  • Add a not equals option (neq) to the custom_property filter.
  • Add sources in the /export/employees/competencies endpoint, to be able to track from which skill events the given competencies originate from.
  • Add support for addresses as an alternative for location coordinates.

August 2022

  • Add include query parameter to vacancies/{vacancy_external_id}/matching_employees to allow retrieving employee information without extra calls.
  • Add include=location query parameter option to employees/{employee_external_id}/matching_vacancies
  • Add a validation_state field to the /export/employees/competencies response. Indicating whether the competencies linked to employees are already validated by a manager or employee or still suggested.

July 2022

  • Add a category field to the POST /competencies and PATCH /competencies/{external_id} endpoints to change the category of a competency.

June 2022

  • Add a PATCH endpoint for skill profile feedback on Employees such that skill profiles can be partially updated.
  • Add last_updated filter for Employee and Vacancy matching.
  • Add an experimental POST /export/employees/competencies endpoint for extracting employee competencies and skills from the API.

May 2022

  • Change how the GET /competencies/{external_id}/skill_profile endpoint returns skill profiles for clients who use a Taxonomy managed by TechWolf.

April 2022

  • Add support for project and certificate Skill Events.
  • Add support for explicit working_history, education_history, and resume_document Skill Events.

March 2022

  • Add support for feedback and goal Skill Events.

February 2022

  • Add include query parameter to employees/{employee_external_id}/recommended_courses to allow retrieving course information without extra calls.

January 2022

  • Add Delete /employees/{employee_external_id}/skill_events/{skill_event_external_id} endpoint to support removing an Employee's Skill Event from the API.
  • Add GET /employees/{employee_external_id}/skill_events endpoint to support fetching an Employee's Skill Events of a specified type in the API. The only allowed event type is a learning_event.
  • Add POST /employees/{employee_external_id}/skill_events endpoint to support the creation of Skill Events in the API. The only allowed event type is a learning_event.

December 2021

  • Add /employees/{employee_external_id}/recommended_courses endpoint, returning the recommended Courses to improve an Employee's skill profile.
  • Removed Certificates from Employees and all its functionalities.
  • The custom property weights for the matching endpoints now support the custom_property_contains, custom_property_contains_element , custom_property_is_in and custom_property_is_in_list configurations. Match scores are increased when the applied condition on the matching entities' specified custom property checks out.
  • The matching endpoints now support the language weight configurations. Match scores are increased when the matching entities' language levels fall between a range of the source entity language levels.

October 2021

  • All endpoints supporting the explained response format now return additional category information when the explained response format is requested.
  • The Get Skill Profile endpoints /entity_type/{ID}/skill_profile now support response_format=categories and thereby return skill category information.
  • The Skill Search endpoint /skills/search now returns skill category information.
  • The Search endpoints now support German (de) language.
  • You can now create and update entities in German with the language=de query parameter.
  • The Reskilling & Deployment report now provides information for key missing skills on an Employee-level.

September 2021

  • The /employees/{employee_external_id}/vacancies/{vacancy_external_id}/match endpoint with response_format=explained query parameter now returns the body with missing skills included under the missing_skills key.
  • Add external Company hiring activity profiling with NACE-codes under the /companies/{external_id}/nace endpoint.
  • Add the Reskilling & Deployment Report available under the /reports/reskilling_and_deployment endpoint.
  • Reskilling & Deployment report now supports a Qlik-friendly CSV output format.
  • Reskilling & Deployment report now supports score_min_threshold.
  • The external_id_is_in_list filter is now supported for the Job Matching and external Company Matching endpoints. Additionally, this filter is also supported for the Search and Similar endpoints of Employee, Vacancy, and external Company.

August 2021

  • The Employability metric now takes into account the supply of Employees that could fill in the demand as well.
  • The Search endpoints now support an optional language query parameter, to indicate the language of the input text.

July 2021

  • companies/:external_id/desired_functions now supports the PUT method. Calling this method replaces all existing desired function vacancies with the new set.
  • Similar Entity endpoints now support score_min_threshold.
  • Similar Entity endpoints now support custom property filters.
  • Similar Entity endpoints for Employees and Vacancies now support location and language based filters.
  • Similar Entity endpoints now support custom property weights.
  • Similar Entity endpoints for Employees and Vacancies now support location weight.

June 2021

  • Add the option to override the location used for geo-distance calculation in matching request filters.
  • max_geo_distance field on Employee entities was deprecated.
  • remove max_geo_distance field on Employee entities.

May 2021

  • You can now use a vacancy-prefix when looking for matching external companies such that filtering and weighting is based on the custom properties of the vacancies associated with the external company, rather than the external company itself.

April 2021

  • Add strict parameter to entity creation and update operations (Employees, Competencies, Courses, Documents, Occupations, Vacancies).
  • Change the outward facing side of (non-)desired functions during Employee creation. Output and input now better reflect internal results.
  • Add languages field to external Companies.
  • You can now add a geo distance weight to the matching endpoints. Match scores are increased when two entities are in proximity to each other.
  • You can now add custom property weights to the matching endpoints. Match scores are increased when the applied condition on the matching entities' specified custom property checks out.
  • Extraction language can now be specified for the POST companies/{external_id}/desired_functions endpoint.

March 2021

  • You can now specify the non-desired functions when creating or updating an Employee to take their negative preference into account when matching to new positions.
  • You can now modify the non-desired functions boost used during matching by setting the appropriate weight on the match endpoints employees/{external_id}/matching_vacancies and vacancies/{external_id}/matching_employees.
  • You can now submit multiple desired functions linked to a given External Company through a single multiline string using the new request_format=free_text query parameter on the /companies/{external_id}/desired_functions endpoint.
  • You can now submit free text, multiline strings desired functions & non-desired functions for an Employee through the desired_functions & non_desired_functions attributes.
  • You can now search for Vacancies and external Companies based on free text, through the endpoints /vacancies/search and /companies/search.
  • You can now add datetime-typed custom properties.
  • You can now provide a list of filters when searching for entities using free text through the endpoints /employees/search, /vacancies/search and /companies/search.
  • You can now provide multiple values (as a list) when using the custom_property_contains_element filter. Entities will not be filtered out if they contain at least one of the provided values in the list custom property.
  • You can now specify the comparison operator when using the custom_property filter. If no operator is specified, the filter defaults to the equals operator.
  • You can now specify an offset on matching endpoints for employees ,vacancies and companies.
  • You can now specify an offset on search endpoints for employees,vacancies and companies.
  • You can now pass the null value for optional fields during creation and updating of all entities. Passing the null value during an update will unset the entity's attribute. Objects will be unset as null, arrays as the empty array [] and strings as the empty string ''.
  • External Companies now support custom properties.
  • (Non-)desired function score boosting is now calculated relative to the relevancy of the function title, instead of a binary boost on occurrence of a title.
  • You can now provide a list of filters at the match endpoints employees/{external_id}/matching_companies and companies/{external_id}/matching_employees. This will be used to filter out entities that do not need to be considered during matching.
  • You can now provide a list of weights at the match endpoints employees/{external_id}/matching_companies and companies/{external_id}/matching_employees. The weights can override some default weights during matching (e.g. desired functions boost).
  • Custom property definitions are no longer allowed to contain double underscores in their name.
  • You can now set the weight of the skills-related match component contributing to the final match score (this was previously hard-coded to 1.0).
  • You can now filter on the custom properties of External Companies linked to a Vacancy, when matching Employees to Vacancies and vice versa.

February 2021

  • You can now search for Employees based on free text, through the endpoint /employees/search.
  • You can add an (optional) External Company link to a Vacancy, through the endpoint /vacancies and attribute company.
  • You can now list, create, retrieve, update and delete External Companies through the endpoints /companies/*.
  • You can now optionally mark Vacancies as inactive using the field active. When this is field has the value False, the Vacancy will not be used for matching.
  • Deleting External Companies now deletes all linked inactive Vacancies in cascade.
  • You can now find the best Employees for a given External Company with an overview of its matching Vacancies, through the endpoint /companies/{external_id}/matching_employees.
  • You can now find the best External Companies for a given Employee with an overview of the matching Vacancies per External Company, through the endpoint /employees/{external_id}/matching_companies.
  • You can now upload desired functions as inactive Vacancies linked to a given External Company, through the endpoint /companies/{external_id}/desired_functions.
  • You can now see when an entity was last updated by checking the attribute last_updated upon entity retrieval.
  • You can now provide a list of filters at the match endpoints employees/{external_id}/matching_vacancies and vacancies/{external_id}/matching_employees. This will be used to filter out entities that do not need to be considered during matching.
  • You can now provide a list of languages with proficiency levels during Vacancy creation.
  • You can now provide a list of weights at the match endpoints employees/{external_id}/matching_vacancies and vacancies/{external_id}/matching_employees. The weights can override some default weights during matching (e.g. desired functions boost).
  • The POST-type methods on matching_vacancies and matching_employees are now the preferred way to request the matches.
  • You can now add a list of strings as a Custom Property.
  • You can now explicitly provide the language used in skill profile extraction during entity creation/update using the language query parameter. Supported languages are auto, nl, fr and en.
  • You can now optionally add a job description to the entries in the working_history of an Employee. These descriptions will also be used for skill extraction.

January 2021

  • You can add a (optional) max_geo_distance attribute when creating an Employee through the endpoint /employees. This is used for matching if there is no max_geo_distance. provided as query parameter. The default distance in our system when nothing is provided, is 50 km.

Breaking Changes

View all breaking changes.

2023-06-13

  • Removed the deprecated PUT {entity}/{external_id}/skill_profile endpoint.

2023-04-21

  • A skill_event with project_content now assumes a textual description of a ticket from a ticketing system (e.g. Jira, Assana, Github issues, etc.). The previous functionality of general project descriptions is removed.

2023-02-21

  • The desired_functions and non_desired_functions fields of the Employee have been changed from lists of titles to list of Function objects. A Function object consists of a Function title and a relative importance.

2023-01-27

  • All instances of competency, competencies or capitalized alternatives have been renamed to skill_cluster and skill_clusters, and their capitalized versions.
  • All instances of category, categories or capitalized alternatives have been renamed to domain and domains, and their capitalized versions.

2022-10-24

  • The competency and score fields in PUT, PATCH /{entity}/{external_id}/skill_profile in competencies format are now renamed to competency_name and proficiency_level respectively.

  • The score fields in PUT, PATCH /{entity}/{external_id}/skill_profile in skills format is replaced by has_skill which is a boolean instead of number.

2022-10-05

  • The competency and score fields in GET /{entity}/{external_id}/skill_profile in competencies format are now renamed to competency_name and proficiency_level respectively.

2022-07-19

  • The score field in GET /{entity}/{external_id}/skill_profile in list format is now optional.

2022-07-18

  • Deprecated GET /employees/{external_id}/recommended_courses and added POST instead.

2022-06-03

  • Removed POST /competencies/{external_id}/similar and POST /competencies/{external_id}/profile/related endpoints.

2022-05-23

  • Removed PUT /competencies/{external_id}/skill_profile feedback endpoint.

2021-11-09

  • Removed Document Entity and all its functionalities.

2021-07-28

  • Similar Entity endpoints are now POST instead of GET.
  • The response format of Similar Entity endpoints has changed from a list to an object containing two fields: the list of results and the total number of results available.

2021-06-04

  • Search endpoints now require weights in the body, in the same manner as matching endpoints.
  • Search endpoints now support a score_min_threshold query parameter, and defaults to 0.5 for this value instead of the previously internal 0.0.

2021-04-30

  • The language query parameter has become required for the creation and update of an entity.

2021-03-19

  • The response format of matching results (GET/POST /employees/{external_id}/matching_vacancies , GET/POST /vacancies/{external_id}/matching_employees , GET /employees/{external_id}/matching_companies and GET /companies/{external_id}/matching_employees) has changed from a list to an object containing two fields: the list of results and the total number of results available.
  • The response format of search results (POST /employees/search , POST /vacancies/search and POST /companies/search) has changed from a list to an object containing two fields: the list of search results and the total number of results available from the free text search.
  • The response format of list results (GET /employees/, GET /vacancies/ , GET /companies/, GET /courses/, GET /competencies/, GET /documents/ and GET /occupations/) has changed from a list to an object containing two fields: the list of results and the total number of results available.

2021-02-25

  • Employee creation (POST /employees) and updates (PATCH /employees/{external_id}) no longer support uploading individual resumes (as employee_resume) in favour of accepting a list of multiple resumes (as employee_documents) with the same format.

2021-02-03

  • The list entity endpoints (GET /employees, GET /vacancies, GET /courses , GET /occupations, GET /competencies and GET /documents) no longer support the response_format query parameter. The response now corresponds to the former objects response format for all endpoints.

2021-01-19

  • The version endpoint now returns a body with a single field version, indicating the current version of your tenant. The version is returned as a date (ISO-8601, ex. 2021-01-19) and no longer as a number.

Domains

Domains in the Skill Engine API allow enterprise customers to adapt Domains in their Taxonomy.

List Domains

Get a list of all Domains available in the system.

Request
Security:
application (read)
query Parameters
limit
integer [ 1 .. 200 ]
Default: 100

The maximal number of Entities returned, ordered by the last_updated field and external_id.

Example: limit=50
offset
integer >= 0
Default: 0

The applied offset for returned Entities, results starting from offset up to offset + limit.

Responses
200OK
401Unauthorized
403Forbidden
405Method Not Allowed
503Service Unavailable
get/taxonomy/domains
Response samples
application/json
{
  • "count": 2,
  • "results": [
    ]
}

Create Domain

Create a new Domain in the system.

Request
Security:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

domain_name
required
string [ 1 .. 255 ] characters

Name of the Domain.

Responses
204No Content
400Bad Request
401Unauthorized
403Forbidden
405Method Not Allowed
409Conflict
503Service Unavailable
post/taxonomy/domains
Request samples
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "domain_name": "IT & Engineering"
}
Response samples
    1 more
    503
application/json
[
  • {
    }
]

Get Domain

Get Domain information stored in the system.

Request
Security:
application (read)
path Parameters
domain_external_id
required
any

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

Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/taxonomy/domains/{domain_external_id}
Response samples
    1 more
    503
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "domain_name": "IT & Engineering",
  • "last_updated": "2021-01-21T17:32:28.000Z"
}

Update Domain

Submit the most up-to-date Domain information. Any field that is present will overwrite existing values within the system, while absent fields will be left as is.

Request
Security:
application (write)
path Parameters
domain_external_id
required
any

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

Request Body schema: application/json
domain_name
string [ 1 .. 255 ] characters

Name of the Domain.

Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
patch/taxonomy/domains/{domain_external_id}
Request samples
application/json
{
  • "domain_name": "IT - HR"
}
Response samples
    1 more
    503
application/json
[
  • {
    }
]

Delete Domain

Delete Domain information stored inside the system. By deleting a Domain, all Skill Clusters linked to this Domain are also deleted.

Request
Security:
application (write)
path Parameters
domain_external_id
required
any

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

Responses
204No Content
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
delete/taxonomy/domains/{domain_external_id}
Response samples
application/json
[
  • {
    }
]

Skill Clusters

Skill Clusters in the Skill Engine API allow enterprise customers to adapt Skill Clusters in their Taxonomy.

List Skill Clusters

Get a list of all Skill Clusters available in the system.

Request
Security:
application (read)
query Parameters
limit
integer [ 1 .. 200 ]
Default: 100

The maximal number of Entities returned, ordered by the last_updated field and external_id.

Example: limit=50
offset
integer >= 0
Default: 0

The applied offset for returned Entities, results starting from offset up to offset + limit.

Responses
200OK
401Unauthorized
403Forbidden
405Method Not Allowed
503Service Unavailable
get/taxonomy/skill_clusters
Response samples
application/json
{
  • "count": 2,
  • "results": [
    ]
}

Create Skill Cluster

Create a new Skill Cluster in the system that is linked to a Domain.

Request
Security:
application (write)
Request Body schema: application/json
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

domain_id
required
string <uuid> [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

The unique ID of a Domain to which this Skill Cluster is linked, consisting of alphanumeric characters, hyphens and underscores.

skill_cluster_name
required
string [ 1 .. 255 ] characters

Name of the Skill Cluster.

skill_cluster_description
required
string

Description of the Skill Cluster.

Responses
204No Content
400Bad Request
401Unauthorized
403Forbidden
405Method Not Allowed
409Conflict
503Service Unavailable
post/taxonomy/skill_clusters
Request samples
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "domain_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skill_cluster_name": "Database Management",
  • "skill_cluster_description": "Knowledge of actions a business takes to manipulate and control data to meet necessary conditions throughout the entire data lifecycle."
}
Response samples
    1 more
    503
application/json
[
  • {
    }
]

Get Skill Cluster

Get the Skill Cluster information stored in the system.

Request
Security:
application (read)
path Parameters
skill_cluster_external_id
required
any

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

Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/taxonomy/skill_clusters/{skill_cluster_external_id}
Response samples
    1 more
    503
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "domain_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skill_cluster_name": "Database Management",
  • "skill_cluster_description": "Knowledge of actions a business takes to manipulate and control data to meet necessary conditions throughout the entire data lifecycle.",
  • "last_updated": "2021-01-21T17:32:28.000Z"
}

Update Skill Cluster

Submit the most up-to-date Skill Cluster information. Any field that is present will overwrite existing values within the system, while absent fields will be left as is.

Request
Security:
application (write)
path Parameters
skill_cluster_external_id
required
any

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

Request Body schema: application/json
domain_id
string <uuid> [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

The unique ID of a Domain to which this Skill Cluster is linked, consisting of alphanumeric characters, hyphens and underscores.

skill_cluster_name
string [ 1 .. 255 ] characters

Name of the Skill Cluster.

skill_cluster_description
string

Description of the Skill Cluster.

Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
patch/taxonomy/skill_clusters/{skill_cluster_external_id}
Request samples
application/json
{
  • "domain_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "skill_cluster_name": "Database Management",
  • "skill_cluster_description": "Knowledge of actions a business takes to manipulate and control data to meet necessary conditions throughout the entire data lifecycle."
}
Response samples
    1 more
    503
application/json
[
  • {
    }
]

Delete Skill Cluster

Delete Skill Cluster information stored inside the system.

Request
Security:
application (write)
path Parameters
skill_cluster_external_id
required
any

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

Responses
204No Content
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
delete/taxonomy/skill_clusters/{skill_cluster_external_id}
Response samples
application/json
[
  • {
    }
]

List Skills

Get a list of all Skills linked to a Skill Cluster.

Request
Security:
application (read)
path Parameters
skill_cluster_external_id
required
any

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

query Parameters
limit
integer [ 1 .. 200 ]
Default: 100

The maximal number of Entities returned, ordered by the skill_id field.

Example: limit=50
offset
integer >= 0
Default: 0

The applied offset for returned Entities, results starting from offset up to offset + limit.

Responses
200OK
401Unauthorized
403Forbidden
405Method Not Allowed
503Service Unavailable
get/taxonomy/skill_clusters/{skill_cluster_external_id}/skills
Response samples
application/json
{
  • "count": 2,
  • "results": [
    ]
}

Add Skill

Add a Skill to a Skill Cluster.

Request
Security:
application (write)
path Parameters
skill_cluster_external_id
required
any

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

skill_id
required
any

The unique Skill ID in the vocabulary of the Skill Engine API, consisting of alphanumeric characters, hyphens and underscores.

Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
put/taxonomy/skill_clusters/{skill_cluster_external_id}/skills/{skill_id}
Response samples
    1 more
    503
application/json
[
  • {
    }
]

Remove Skill

Remove a Skill from a Skill Cluster.

Request
Security:
application (write)
path Parameters
skill_cluster_external_id
required
any

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

skill_id
required
any

The unique Skill ID in the vocabulary of the Skill Engine API, consisting of alphanumeric characters, hyphens and underscores.

Responses
204No Content
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
delete/taxonomy/skill_clusters/{skill_cluster_external_id}/skills/{skill_id}
Response samples
application/json
[
  • {
    }
]

Skills

Get Skill

Get the Skill information stored inside the Vocabulary.

Request
Security:
application (read)
path Parameters
skill_id
required
any

The unique Skill ID in the vocabulary of the Skill Engine API, consisting of alphanumeric characters, hyphens and underscores.

Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/taxonomy/skills/{skill_id}
Response samples
    1 more
    503
application/json
{
  • "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
  • "skill_name": "Python",
  • "skill_description": "Python is a high-level programming language with an intuitive syntax and a versatile standard library.The skill \\\"Python\\\" requires the ability to write code in the Python programming language."
}

List Skills

Get the Skill information stored inside the system for multiple Skills.

Request
Security:
application (read)
query Parameters
limit
integer [ 1 .. 200 ]
Default: 100

The maximal number of Entities returned, ordered by the skill_id field.

Example: limit=50
offset
integer >= 0
Default: 0

The applied offset for returned Entities, results starting from offset up to offset + limit.

include
Array of strings

Additional Skill info attributes that will be included in the response body.

Items Value: "description"
Example: include=description
Responses
200OK
401Unauthorized
403Forbidden
405Method Not Allowed
503Service Unavailable
get/taxonomy/skills
Response samples
application/json
{
  • "results": [
    ],
  • "count": 2
}

Taxonomy operations

Taxonomy operations can be used to view or edit large parts of the Taxonomy.

Get Taxonomy export

Get an export of the entire Taxonomy.

Request
Security:
application (read)
query Parameters
include
Array of strings

Additional attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Items Value: "skill_description"
Example: include=skill_description
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/taxonomy/export
Response samples
    1 more
    503
application/json
{
  • "domains": [
    ]
}

Get Taxonomy changes

Get a list of changes to the taxonomy within a certain timeframe.

Request
Security:
application (read)
query Parameters
limit
integer [ 1 .. 200 ]
Default: 100

The maximal number of Taxonomy changes returned, ordered by their timestamp.

Example: limit=50
offset
integer >= 0
Default: 0

The applied offset for the returned Taxonomy changes, results starting from offset up to offset + limit.

required
string or string

The earliest timestamp (in IS08601 format) for which you want to retrieve Taxonomy changes.

Example: timestamp_from=2021-01-21T00:00:00.000Z
required
string or string

The latest timestamp (in IS08601 format) for which you want to retrieve Taxonomy changes.

Example: timestamp_to=2022-02-22T00:00:00.000Z
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/taxonomy/changes
Response samples
    1 more
    503
application/json
{
  • "count": 1,
  • "changes": [
    ]
}

Apply Taxonomy changes

Apply a set of changes to the Taxonomy in the system. The changes are applied in the order they are given in the request body.

Request
Security:
application (write)
Request Body schema: application/json
required
Array of objects (Change)
Responses
204No Content
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
422Unprocessable Entity
503Service Unavailable
post/taxonomy/apply
Request samples
application/json
{
  • "changes": [
    ]
}
Response samples
    1 more
    503
application/json
[
  • {
    }
]

CRUD

Employees in the Skill Engine API represent either a person within your organisation or a candidate within the job market.

More info about Entities can be found on the How it Works page

List Employees

Get a list of all Employees available in the system. This can for example be used to keep track of proper synchronisation between your system and the Skill Engine API.

Request
Security:
application (read)
query Parameters
limit
integer [ 1 .. 200 ]
Default: 100

The maximal number of Entities returned, ordered by the last_updated field and external_id.

Example: limit=50
offset
integer >= 0
Default: 0

The applied offset for returned Entities, results starting from offset up to offset + limit.

Responses
200OK
401Unauthorized
403Forbidden
405Method Not Allowed
503Service Unavailable
get/employees
Response samples
application/json
{
  • "count": 3,
  • "results": [
    ]
}

Create Employee

Submit new Employee information to initialise their Skill Profile inside the Skill Engine API.

Request
Security:
application (write)
query Parameters
language
required
string

The language of the input data, which has an impact on the skill extraction. auto will automatically detect the language used in the provided data.

Enum: "auto" "nl" "fr" "en" "de"
Example: language=en
strict
boolean
Default: true

If strict is enabled, entity creation will fail when a skill profile cannot be constructed. If strict is set to false, failed skill profile creation will still result in entity creation, but the skill profile will be empty.

Request Body schema: application/json
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

assigned_position
string or null (AssignedPosition) [ 1 .. 255 ] characters

Job title of the Employee's assigned position.

Array of objects or null (WorkExperience)

The working history of an Employee. It is recommended to add these through the Skill Event endpoints as to not overwrite any existing Working History events.

Array of objects or null (Education)

The education history of an Employee. It is recommended to add these through the Skill Event endpoints as to not overwrite any existing Education History events.

Array of objects or null (Language)

List of ISO 639-1 codes for languages spoken by the Employee, combined with the proficiency level. The proficiency levels go from 1 (elementary proficiency) to 5 (native proficiency). If the level is omitted, the default proficiency level of 2 is used.

Array of objects or null (Function)

List of desired functions of the Employee. Elements consist of a title and a relative importance. The title can be either a single-line string or free text. The desired function is only processed and stored when the desired function is recognized by TechWolf AI.

Array of objects or null (Function)

List of non-desired functions of the Employee. Elements consist of a title and a relative importance. The title can be either a single-line string or free text. The non-desired function is only processed and stored when the non-desired function is recognized by TechWolf AI.

Location (object) or LocationAddress (object)

Either a Location object, containing a latitude and longitude, or either a LocationAddress object, containing a country, city and postal code (A state and street address are optional).

Array of objects or null (EmployeeResume)

List of base64 encoded documents (e.g. CVs) related to the Employee in PDF (.pdf), Word (.doc or .docx) or plain-text (.txt) format. It is recommended to add these through the Skill Event endpoints as to not overwrite any existing Resume Document events.

Responses
204No Content
400Bad Request
401Unauthorized
403Forbidden
405Method Not Allowed
409Conflict
413Payload Too Large
415Unsupported Media Type
422Unprocessable Entity
503Service Unavailable
post/employees
Request samples
application/json
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "assigned_position": "Python Developer",
  • "working_history": [
    ],
  • "education_history": [
    ],
  • "languages": [
    ],
  • "desired_functions": [
    ],
  • "non_desired_functions": [
    ],
  • "location": {
    },
  • "employee_documents": [
    ]
}
Response samples
    4 more
    413
    415
    422
    503
application/json
BadRequestSchema
BadRequestSchema
MaxEntitiesSchema
[
  • {
    }
]

Get Employee

Get the Employee information stored inside the system. As resumes are not stored inside our system, they are not returned in this call.

Request
Security:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
query Parameters
include
Array of strings

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Items Value: "custom_properties"
Example: include=custom_properties
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/employees/{external_id}
Response samples
    1 more
    503
application/json
default
default
custom_properties
{
  • "last_updated": "2021-01-21T17:32:28.000Z",
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "assigned_position": "Python Developer",
  • "working_history": [
    ],
  • "education_history": [
    ],
  • "languages": [
    ],
  • "desired_functions": [
    ],
  • "non_desired_functions": [
    ],
  • "location": {
    }
}

Update Employee

Submit the most up-to-date Employee information to update their profile inside the system. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Since the Employee resume is deleted after creating a skill profile, it is a required field for recalculating the skill profile based on the resume. If no resume is provided, the skill profile will be recalculated based on the other available properties.

Passing the null value removes non-required attributes. Object attributes will be removed when passing null, arrays with [] and strings with the empty string ''.

Request
Security:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
query Parameters
language
required
string

The language of the input data, which has an impact on the skill extraction. auto will automatically detect the language used in the provided data.

Enum: "auto" "nl" "fr" "en" "de"
Example: language=en
strict
boolean
Default: true

If strict is enabled, entity creation will fail when a skill profile cannot be constructed. If strict is set to false, failed skill profile creation will still result in entity creation, but the skill profile will be empty.

Request Body schema: application/json
assigned_position
string or null (AssignedPosition) [ 1 .. 255 ] characters

Job title of the Employee's assigned position.

Array of objects or null (WorkExperience)

The working history of an Employee. It is recommended to add these through the Skill Event endpoints as to not overwrite any existing Working History events.

Array of objects or null (Education)

The education history of an Employee. It is recommended to add these through the Skill Event endpoints as to not overwrite any existing Education History events.

Array of objects or null (Language)

List of ISO 639-1 codes for languages spoken by the Employee, combined with the proficiency level. The proficiency levels go from 1 (elementary proficiency) to 5 (native proficiency). If the level is omitted, the default proficiency level of 2 is used.

Array of objects or null (Function)

List of desired functions of the Employee. Elements consist of a title and a relative importance. The title can be either a single-line string or free text. The desired function is only processed and stored when the desired function is recognized by TechWolf AI.

Array of objects or null (Function)

List of non-desired functions of the Employee. Elements consist of a title and a relative importance. The title can be either a single-line string or free text. The non-desired function is only processed and stored when the non-desired function is recognized by TechWolf AI.

Location (object) or LocationAddress (object)
Array of objects (EmployeeResume)

List of base64 encoded documents (e.g. CVs) related to the Employee in PDF (.pdf), Word (.doc or .docx) or plain-text (.txt) format.

Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
413Payload Too Large
415Unsupported Media Type
422Unprocessable Entity
503Service Unavailable
patch/employees/{external_id}
Request samples
application/json
{
  • "assigned_position": "Python Developer",
  • "working_history": [
    ],
  • "education_history": [
    ],
  • "languages": [
    ],
  • "desired_functions": [
    ],
  • "non_desired_functions": [
    ],
  • "location": {
    },
  • "employee_documents": [
    ]
}
Response samples
    4 more
    413
    415
    422
    503
application/json
[
  • {
    }
]

Delete Employee

Remove an Employee from the system. This step deletes all information linked exclusively to this Employee. If these need to be removed as well, make sure to do this separately. By deleting an Employee, you delete their skill profile history, which cannot be recreated or recovered afterwards.

Request
Security:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Responses
204No Content
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
delete/employees/{external_id}
Response samples
application/json
[
  • {
    }
]

Get all Custom Property Definitions

Get a list of all the Custom Property Definitions stored inside the system.

Request
Security:
application (read)
Responses
200OK
403Forbidden
405Method Not Allowed
503Service Unavailable
get/employees/custom_properties
Response samples
application/json
[
  • {
    },
  • {
    }
]

Create a Custom Property Definition

Create a new Custom Property Definition in the system.

Request
Security:
application (write)
Request Body schema: application/json
property_name
required
string [ 1 .. 100 ] characters

The name of the custom property. Can not contain '__'.

property_type
required
string [ 1 .. 10 ] characters

Expected type of the custom property.

Enum: "text" "number" "boolean" "list[text]" "datetime"
Responses
204No Content
400Bad request
401Unauthorized
405Method Not Allowed
503Service Unavailable
post/employees/custom_properties
Request samples
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}
Response samples
application/json
[
  • {
    }
]

Get Custom Property Definition

Get the Custom Property Definition information stored inside the system.

Request
Security:
application (read)
path Parameters
property_name
required
string [ 1 .. 100 ] characters
Example: sector
Responses
200OK
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/employees/custom_properties/{property_name}
Response samples
application/json
{
  • "property_name": "sector",
  • "property_type": "text"
}

Rename a Custom Property Definition

Rename a Custom Property Definition.

Request
Security:
application (write)
path Parameters
property_name
required
string [ 1 .. 100 ] characters
Example: sector
Request Body schema: application/json
property_name
required
string [ 1 .. 100 ] characters

The name of the custom property. Can not contain '__'.

Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
409Conflict
415Unsupported Media Type
503Service Unavailable
patch/employees/custom_properties/{property_name}
Request samples
application/json
{
  • "property_name": "sector"
}
Response samples
    3 more
    409
    415
    503
application/json
[
  • {
    }
]

Remove a Custom Property Definition from the system

Remove a Custom Property Definition from the system.

Request
Security:
application (write)
path Parameters
property_name
required
string [ 1 .. 100 ] characters
Example: sector
Responses
204No Content
401Unauthorized
404Not Found
405Method Not Allowed
503Service Unavailable
delete/employees/custom_properties/{property_name}
Response samples
application/json
[
  • {
    }
]

Retrieve all custom Employee properties

Fetch all Employee properties from the system (if any exists, otherwise an empty list is returned).

Request
Security:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/employees/{external_id}/custom_properties
Response samples
    1 more
    503
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Replace custom Employee properties

In addition to the default fields available for each Employee, a set of custom properties can be added. Each Employee is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Request
Security:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
required
string non-empty
required
boolean or (Number (integer or number)) or (Date (string or string)) or string or Array of strings
Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
413Payload Too Large
415Unsupported Media Type
422Unprocessable Entity
503Service Unavailable
put/employees/{external_id}/custom_properties
Request samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
Response samples
    4 more
    413
    415
    422
    503
application/json
BadJSON
BadJSON
DefintionNotFound
BadCustomPropertyType
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Update custom Employee properties

In addition to the default fields available for each Employee, a set of custom properties can be added. Each Employee is allowed to have a maximum of 100 properties, with properties being numbers or strings (maximum length 1000 characters).

Request
Security:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Request Body schema: application/json
Array ([ 1 .. 100 ] items)
property_name
required
string non-empty
required
boolean or (Number (integer or number)) or (Date (string or string)) or string or Array of strings
Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
413Payload Too Large
415Unsupported Media Type
422Unprocessable Entity
503Service Unavailable
patch/employees/{external_id}/custom_properties
Request samples
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
Response samples
    4 more
    413
    415
    422
    503
application/json
BadJSON
BadJSON
DefintionNotFound
BadCustomPropertyType
{
  • "title": "400 Bad Request",
  • "description": "The request body was not structured correctly."
}

Delete all custom Employee properties

Drop all Employee properties from the system (if any exists).

Request
Security:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Responses
204No Content
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
delete/employees/{external_id}/custom_properties
Response samples
application/json
[
  • {
    }
]

Skill Profile

Get the skill profile for an Employee

Get an export of the Employee skill profile to leverage it for user interaction. Check our tutorials for a clear overview of how to get the most out of each format!

Request
Security:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
query Parameters
response_format
string
Default: "list"

The format of the response profile. More info about adding your Skill Clusters can be found in the tutorials.

Enum: "list" "trending" "skill_clusters" "domains"
Example: response_format=list
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/employees/{external_id}/skill_profile
Response samples
    1 more
    503
application/json
EmployeeListSkillProfile
EmployeeListSkillProfile
EmployeeTrendingSkillProfile
EmployeeListSkillClusterProfile
EmployeeDomainsSkillProfile
{
  • "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "num_skill_events": 5,
  • "skills": [
    ]
}

Partially update an Employee skill profile with feedback

Provide feedback about an existing Employee skill profile to update it inside the system. When the feedback_format query parameter is skills, the body of the feedback message overwrites, adds or updates skills in the original profile. When the feedback_format query parameter is skill_clusters, this endpoint will change the Skill Cluster skills in the skill profile to fit the given Skill Cluster proficiency level.

Request
Security:
application (write)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
query Parameters
feedback_format
string
Default: "skills"

The format in which feedback for the skill profile is given.

Enum: "skills" "skill_clusters"
Example: feedback_format=skills
Request Body schema: application/json
One of:
Array of objects (SkillWithRequiredHasSkillArray)

The skills contained in this profile.

Responses
204No Content
400Bad request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
415Unsupported Media Type
503Service Unavailable
patch/employees/{external_id}/skill_profile
Request samples
application/json
SkillProfileUpdateMessage
SkillProfileUpdateMessage
EmployeeSkillClusterProfileUpdateMessage
{
  • "skills": [
    ]
}
Response samples
    2 more
    415
    503
application/json
[
  • {
    }
]

Metrics

A metric is a single number representing some amount of information about an Entity or a collection of Entities of the same type.

More info about Metrics can be found on the How it Works page .

Get the employability metric

Retrieve the employability for this Employee. Employability is influenced by two factors: the number of matching Vacancies (demand) & the number of Employees that could fill those Vacancies (supply). It is reported as a number between 0 and 1, with the upper end indicating that an Employee has many matching opportunities (= high demand) for which there are not many matching Employees (= low supply). A lower score indicates fewer opportunities (= low demand), or that there is already a high supply of those profiles.

Request
Security:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/employees/{external_id}/metrics/employability
Response samples
    1 more
    503
application/json
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "employability",
  • "metric_value": 0.8,
  • "last_update": "2020-09-01T11:45:49Z"
}

Get the employability metric using filters and weights

Retrieve the employability for this Employee. Employability is influenced by two factors: the number of matching Vacancies (demand) & the number of Employees that could fill those Vacancies (supply). It is reported as a number between 0 and 1, with the upper end indicating that an Employee has many matching opportunities (= high demand) for which there are not many matching Employees (= low supply). A lower score indicates fewer opportunities (= low demand), or that there is already a high supply of those profiles.

Request
Security:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
Request Body schema: application/json
Array of max_geo_distance (object) or custom_property (object)
Array of max_geo_distance (object) or custom_property (object)
Array of skills_match (object) or desired_functions (object) or non_desired_functions (object)
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
post/employees/{external_id}/metrics/employability
Request samples
application/json
{
  • "employee_filters": [
    ],
  • "vacancy_filters": [
    ],
  • "weights": [
    ]
}
Response samples
    1 more
    503
application/json
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "employability",
  • "metric_value": 0.8,
  • "last_update": "2020-09-01T11:45:49Z"
}

Get Employee count

Get the total number of Employee objects stored inside the system.

Request
Security:
application (read)
Responses
200OK
401Unauthorized
403Forbidden
405Method Not Allowed
503Service Unavailable
get/employees/metrics/count
Response samples
application/json
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "count",
  • "metric_value": 1000,
  • "last_update": "2020-09-01T11:45:49Z"
}

Get the position alignment metric

Retrieve the position alignment for this Employee. Position alignment is an indication of the extent to which an Employee fits their assigned position within your company. It is reported as a number between 0 and 1, with the upper end indicating that an Employee is a good fit for their assigned position, while a lower score indicates that the employee may have some missing skills.

Request
Security:
application (read)
path Parameters
external_id
required
string <uuid> (UUID) [ 1 .. 100 ] characters [a-zA-Z0-9_-]+

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

Example: a3903505-eb84-42dc-a79f-5e7b1fe897b7
query Parameters
response_format
string
Default: "simple"

The format in which the position alignment metric needs to be returned. The simple response format only returns the position alignment score. While the explained response format also returns relevant experience and skills.

Enum: "simple" "explained"
Example: response_format=simple
Responses
200OK
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
503Service Unavailable
get/employees/{external_id}/metrics/position_alignment
Response samples
    1 more
    503
application/json
EmployeePositionAlignment
EmployeePositionAlignment
ExplainedEmployeePositionAlignment
{
  • "entity_type": "Employee",
  • "entity_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  • "metric_name": "position_alignment",
  • "metric_value": 0.8,
  • "last_update": "2020-09-01T11:45:49Z"
}

Search

Search for Employees based on free text

Search for Employees

Request
Security:
application (read)
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

The maximal number of results returned.

Example: limit=10
offset
integer >= 0
Default: 0

The rank offset for returned matches, return matches starting from rank offset up to rank offset+limit.

score_min_threshold
number <float> [ 0 .. 1 ]
Default: 0.5

The minimum score of the results. Due to approximations for fast result-delivery, there might be records with a score slightly lower than the minimum.

Example: score_min_threshold=0.7
language
string
Default: "auto"

The language of the input text. auto will automatically detect the language used.

Enum: "auto" "nl" "fr" "en" "de"
Example: language=en
Request Body schema: application/json
text
required
string

Input text.

Location (object) or LocationAddress (object)
required
Array of max_geo_distance (object) or custom_property (object) or custom_property_is_in_list (object) or custom_property_contains_element (object) or external_id_is_in_list (object) or exclude_match_feedback (object)
required
Array of geo_distance (object) or custom_property (object) or desired_functions (object) or non_desired_functions (object) or skills_match (object)
Responses
200OK
400Bad request
401Unauthorized
403Forbidden
405Method Not Allowed
413Payload Too Large
415Unsupported Media Type
422Unprocessable Entity
503Service Unavailable
post/employees/search
Request samples
application/json
{
  • "text": "Bakery",
  • "location": {
    },
  • "filters": [
    ],
  • "weights": [
    ]
}
Response samples
    4 more
    413
    415
    422
    503
application/json
[
  • {
    }
]

Skill Events

A Skill Event influences the skillset of an Employee. When an Employee finishes a course, receives feedback, starts a new function, or when another event occurs that gives additional info to an Employee's skill profile, a Skill Event can be generated.

Skill Events allow you to monitor the evolution of an Employee's skill pro