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.
February 2025
- Allow patching of Organisational Units with
parent_id=null
to become a root Organisational Unit in thePATCH /organisational_units/{external_id}
endpoint. - Add
GET /job_architecture/peer_groups
endpoint.
January 2025
- Add the optional
proficiency_float
field to the request body of thePATCH /job_architecture/jobs/{job_external_id}/skill_profile
andPATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints. - Add the
include=proficiency_float
option to the include query parameter of theGET /job_architecture/jobs/{job_external_id}/skill_profile
andGET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints. - Add the
include=proficiency_float
option to the include body parameter of thePOST /job_architecture/export/jobs/skill_profiles
andPOST /job_architecture/export/job_families/skill_profiles
endpoints. - Add the
external_vendor
query parameter to thePOST /employees/suggestions/skills
endpoint - Remove the
strict
query parameter from thePOST /employees/suggestions/skills
endpoint - Add the
include=critical
option to the include query parameters to theGET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
endpoint. - Update the
include
parameter in theGET /job_architecture/jobs/{job_external_id}/skill_profile
andGET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints to allowproficiency_level
andcritical
to be included withresponse_format=hierarchy
- Make the
skill_cluster_description
optional and set it to an empty string by default. Additionally, save any placeholder value or a description that exactly matches the Skill Cluster name as an empty string.
December 2024
- Add the
include=proficiency_level
andinclude=critical
options to the include body parameter of thePOST /job_architecture/export/jobs/skill_profiles
endpoint. - Add the
include=proficiency_level
andinclude=critical
options to the include body parameter of thePOST /job_architecture/export/job_families/skill_profiles
endpoint. - Add the
external_vendor
query parameter to theGET /skills/search
endpoint. - Return the default proficiency level when no proficiency level is set in the
GET /job_architecture/jobs/{job_external_id}/skill_profile
,POST /job_architecture/export/jobs/skill_profiles
,GET /job_architecture/job_families/{job_family_external_id}/skill_profile
, andPOST /job_architecture/export/job_families/skill_profiles
endpoints. - Add the
force_recalculate
query parameter to all report endpoints.
November 2024
- Add
limit
,offset
, andupdate_low_data_availability
query parameters to theGET /reports/data_maturity_scan/employee_maturity_overview
andGET /reports/data_maturity_scan/job_maturity_overview
endpoints. - Add
include=skill_cluster_description
parameter to theGET /taxonomy/skill_clusters
endpoint. - Add
skill_cluster_description
response body field and query parameterinclude=skill_cluster_description
to theGET taxonomy/export
endpoint. - Add the
PATCH /taxonomy/skills/{skill_id}
endpoint. - Return the custom Skill description in the
GET /taxonomy/skills
,GET /taxonomy/skills/{skill_id}
, andGET /taxonomy/export
endpoints if one is set. - Add the
update_skill
operation type to theGET /taxonomy/changes
andPOST /taxonomy/apply
endpoints. - Add
include=skill_description
parameter to the/taxonomy/skill_clusters/{skill_cluster_external_id}/skills
endpoint. - Add
GET /job_architecture/jobs/{job_external_id}/market_skill_profiles
andPOST /job_architecture/export/jobs/market_skill_profiles
endpoints. - Add the
proficiency_level
andcritical
attributes to the request body of thePATCH /job_architecture/jobs/{job_external_id}/skill_profile
endpoint. - Add the
proficiency_level
andcritical
attributes to the request body of thePATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoint. - Add the
include=proficiency_level
andinclude=critical
query parameters to theGET /job_architecture/jobs/{job_external_id}/skill_profile
andGET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.
October 2024
- Add
POST /job_architecture/jobs/metrics/adoption_metrics
endpoint. - Add
POST /employees/metrics/adoption_metrics
endpoint. - Add
source_data
toskills
returned inGET/job_architecture/jobs/{job_external_id}/skill_profile
andGET/job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints. - Add CRUD operations for Custom Properties and Custom Property Definitions for Organisational Units.
- Add
active
attribute to the Organisational Unit entity. - Add
hierarchy
as a possible response format for theGET /employees/{employee_external_id}/skill_profile
endpoint. - Add
include=custom_properties
parameter toGET/job_architecture/job_families
,GET/job_architecture/jobs
,GET/courses
,GET/vacancies
,GET/employees
,GET/companies
,GET/taxonomy/domains
,GET/taxonomy/subdomains
,GET/taxonomy/skill_clusters
andGET/taxonomy/skills
endpoints. - Add
output_skills_sorting
parameter toGET /job_architecture/export/job_families/suggested_skill_profiles
,GET /job_architecture/export/job_families/skill_profiles
,GET /job_architecture/export/jobs/suggested_skill_profiles
andGET /job_architecture/export/jobs/skill_profiles
endpoints. - Deprecate the
GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint. - Add the
vocab_update_rename_skill
,vocab_update_merge_skill
, andvocab_update_remove_skill
operation types to theGET /taxonomy/changes
endpoint.
September 2024
- Add
GET /job_architecture/jobs/{job_external_id}/matching_source_jobs
endpoint. - Add
GET /job_architecture/jobs/{job_external_id}/matching_target_jobs
endpoint. - Add error code 400 as possible response code for
DELETE /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
forDELETE /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
when trying to delete Skill Profile Feedback instances and respective examples for this - Add
GET /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
endpoint. - Add
skill_profile_feedback
as adata_type
to the Job Family Profile Data of a Job Family. This newdata_type
may be included the responses ofGET /job_architecture/job_families/{job_family_external_id}/profile_data
andGET /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
. - Add
GET /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
endpoint. - Add
skill_profile_feedback
as adata_type
to the Job Profile Data of a Job. This newdata_type
may be included the responses ofGET /job_architecture/jobs/{job_external_id}/profile_data
andGET /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
. - Add
skill_id
query parameter to theGET /employees
andGET /organisational_units/export
endpoints that allows for filtering the returned entities on whether their Skill Profile contains a certain Skill. - Add an experimental
POST /employees/suggestions/skill
endpoint that allows to find suggested, validated, and rejected Skill suggestions for Employees. - Add
en_us
,de
, andfr
to the list of supported values for thevocab_language
query parameters in theGET /{entity}/{external_id}/skill_profile
,GET /taxonomy/skill_clusters/{external_id}/skills
,GET /taxonomy/skill/
, andGET /taxonomy/export/
endpoints. - Add the
low_data_availability_flag
to the possible values of theinclude
query parameter of theGET /organisational_units/export
andGET /job_architecture/export
endpoints. - Add
skill_id
query parameter to theGET /job_architecture/export
endpoint that allows for filtering the entities on whether their Skill Profile contains a certain Skill. - Add
source_coverage
metric to the response of theGET /reports/data_maturity_scan/job_quality_matrix
andGET /reports/data_maturity_scan/employee_quality_matrix
endpoints. - Add
skill_name
,skill_cluster_name
,subdomain_name
, anddomain_name
to the output ofGET /taxonomy/changes
. - Add
subdomain_name
to output of thePOST /job_architecture/export/jobs/skill_clusters
,POST /export/employees/skill_clusters
andGET /employees/<employee_id>/skill_profile?response_format=skill_clusters
endpoints for 4-level Taxonomies. - Add
source_data
to the output ofGET /jobs/{job_external_id}/suggested_skill_profile
,GET /job_families/{job_family_external_id}/suggested_skill_profile
,POST /job_architecture/export/jobs/suggested_skill_profiles
, andPOST /job_architecture/export/job_families/suggested_skill_profiles
. - Add endpoints
POST /integrations/file_load_task
to upload a CSV-file from S3 into the system andGET /integrations/file_load_task/{task_id}
to get the status of the File Load Task.
August 2024
- Add
skill_validation_state
to the possible values of theinclude
query parameter of theGET /job_architecture/export/jobs/skill_profiles
,GET /job_architecture/export/jobs/suggested_skill_profiles
,GET /job_architecture/export/job_families/skill_profiles
, andGET /job_architecture/export/job_families/suggested_skill_profiles
endpoints. - Add
skill_validation_state
to the possible values of theinclude
query parameter of theGET /job_architecture/job_families/{job_family_external_id}/skill_profile
andGET /job_architecture/job_families/{job_family_external_id}/suggested_skill_profile
endpoints. - Add
skill_validation_state
to the possible values of theinclude
query parameter of theGET /job_architecture/jobs/{job_external_id}/skill_profile
andGET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
endpoints. - Add Employee and Job key metric reports.
GET /reports/employees/key_metrics
GET /reports/jobs/key_metrics
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
July 2024
- Add CRUD operations for Organisational Units.
- Add export endpoint
GET /organisational_units/export
to get the full hierarchy of the Organisational Units including thetotal_nr_of_employees
field. - Added
organisational_unit
field to Employees that is returned inGET /employees
andGET /employees/{external_id}
. - Added query parameter
organisational_unit
toGET /employees
to filter Employees on their linked Organisational Unit. - Added the
low_data_availability_flag
to the possible values of theinclude
query parameter of theGET /employees/{external_id}/skill_profile
andGET /job_architecture/jobs/{job_external_id}/skill_profile
endpoints. - Added the
low_data_availability_flag
to the possible values of theinclude
body parameter of thePOST /export/employees/skill_profiles
andPOST /job_architecture/export/jobs/skill_profiles
endpoints that allows including the low data availability flag in the output. - Added the option to upload files of data type
job_description
as Job Profile Data. Available in thePOST /job_architecture/jobs/{job_external_id}/profile_data
andPATCH /job_architecture/jobs/{job_external_id}/profile_data
endpoint. - Added the option to upload files of data type
job_family_description
as Job Family Profile Data. Available in thePOST /job_architecture/job_families/{job_family_external_id}/profile_data
andPATCH /job_architecture/job_families/{job_family_external_id}/profile_data
endpoint.
June 2024
- Add
low_data_availability
attribute to the Employee entity. - Add
low_data_availability
attribute to the Job entity. - Added Data Maturity Scan reporting endpoints:
GET /reports/data_maturity_scan/employee_quality_matrix
GET /reports/data_maturity_scan/job_quality_matrix
GET /reports/data_maturity_scan/employee_maturity_overview
GET /reports/data_maturity_scan/job_maturity_overview
GET /reports/data_maturity_scan/data_improvement_actions
- Added
rejected_skills
to the possible values of theinclude
body parameter of thePOST /export/employees/skill_profiles
endpoint that allows including rejected Skills in the output.
May 2024
- Add
GET /employees/{employee_external_id}/jobs/{job_external_id}/match
endpoint that allows to match an Employee with a Job. - Add
POST /employees/{employee_external_id}/matching_jobs
endpoint that allows to find the top matching Jobs for an Employee. - Add
POST /job_architecture/jobs/{external_id}/matching_employees
endpoint that allows to find the top matching Employees for a Job. - Add
POST /job_architecture/job_families/{external_id}/matching_employees
endpoint that allows to find the top matching Employees for a Job Family. - Add
POST /employees/{employee_external_id}/jobs/{job_external_id}/recommended_courses
endpoint that recommends Courses to address the Skill Gap between the Employee and the Job. - Add
GET /employees/{employee_external_id}/job_families/{job_family_external_id}/match
endpoint that allows to match an Employee with a Job Family. - Add
GET /employees/{employee_external_id}/match_assigned_position
endpoint that allows to match an Employee with their assigned position. - Add
POST /export/employees/match_assigned_position
endpoint that allows to match Employees with their assigned position in bulk. - Add
output_skills_sorting
body parameter to thePOST /export/employees/skill_profiles
endpoint, allowingalphabetical
to sort the Skills in the resulting profiles alphabetically, orconfidence
to sort them by decreasing confidence. - Add
is_active
filter to thePOST /job_architecture/export/jobs/skill_profiles
,POST /job_architecture/export/jobs/suggested_skill_profiles
,POST /job_architecture/export/jobs/skill_clusters
,POST /job_architecture/export/job_families/skill_profiles
,POST /job_architecture/export/job_families/suggested_skill_profiles
,POST /export/employees/skill_profiles
,POST /export/employees/skill_clusters
,POST /export/courses/skill_profiles
export endpoints to only include active or inactive entities in the result based on the filter value. - Add
is_active
query parameter to theGET /job_architecture/export
export endpoint to only include active or inactive jobs and job families in the result. - Add
is_active
query parameter to theGET /employees
,GET /vacancies
,GET /courses
,GET /job_architecture/jobs
,GET /job_architecture/job_families
list endpoints to only include active or inactive entities in the result. - Add
include=entity
andinclude=custom_properties
query parameter toPOST /employees/{external_id}/matching_job_families
. - Removed
Core
as a possible value of theskill_type
field of a Skill in the Job Family Skill Profile. - Add
response_format=explained
query parameter toPOST /employees/{external_id}/matching_vacancies
,POST /vacancies/{external_id}/matching_employees
andPOST /employees/{external_id}/matching_job_families
, that includesmissing_skills
andpresent_skills
response body fields as additional information about the matches. - Add
include=adoption
query parameter to thetaxonomy/skills/{skill_id}
endpoint to include the adoption of the Skill in Jobs and Employees in the response. - Add
assigned_position_id
attribute to the Employee entity. - Allow
PATCH /employees/<employee_id>/skill_events/<event_id>
on theresume_document
,feedback
,goal
,project
,certificate
,learning
andticket
event types.
April 2024
- Add
active
attribute to Course, Employee, Job and Job Family entity. - Add support to display Skill Profiles in external vendor Skills on GET,
using the query parameter
external_vendor
, for Course, Employee, Job and Job Family entities. Usage: GET /employee/{employee_id}/skill_profile?external_vendor={external_vendor}
GET /job_architecture/jobs/{job_external_id}/skill_profile?external_vendor={external_vendor}
GET /job_architecture/job_families/{job_family_external_id}/skill_profile?external_vendor={external_vendor}
GET /courses/{external_id}/skill_profile?external_vendor={external_vendor}
- Add support to provide feedback to Skill Profiles in external vendor Skills,
using the query parameter
feedback_format=external_vendor_skills
, for Course, Employee, Job and Job Family entities. Usage:PATCH /employee/{employee_id}/feedback_format=external_vendor_skills
PATCH /job_architecture/jobs/{job_external_id}/skill_profile?feedback_format=external_vendor_skills
PATCH /job_architecture/job_families/{job_family_external_id}/skill_profile?feedback_format=external_vendor_skills
PATCH /courses/{external_id}/skill_profile?feedback_format=external_vendor_skills
- Deprecate
GET /employee{employee_external_id}/vacancy/{vacancy_external_id}/recommend_courses
- Add
POST /employee{employee_external_id}/vacancy/{vacancy_external_id}/recommend_courses
endpoint which makes use of an updated and improved methodology to recommend Courses. - Update
POST /employee{employee_external_id}/recommend_courses
endpoint in line with the updated and improved methodology to recommend Courses.
March 2024
- Add
POST /job_architecture/export/jobs/suggested_skill_profiles
endpoint to paginate through all suggested Skill Profiles of Jobs in the API in bulk. - Add
POST /job_architecture/export/job_families/suggested_skill_profiles
endpoint to paginate through all suggested Skill Profiles of Job Families in the API in bulk. - The
domain_namespace
query parameter is available on thejob_architecture/export/jobs/skill_profiles
andjob_architecture/export/job_families/skill_profiles
endpoints. - When requesting an Employee Skill Profile through either
GET /employee/{employee_id}/skill_profile
orPOST /export/employees/skill_profiles
, the response will now include thesource_events
field on all Skills, when requesting sources.source_events
provides more insights into which Skill Event contributes to which skill.
February 2024
- Add
GET /employees/{employee_id}/skill_events/{skill_event_id}
endpoint to be able to get a single Skill Event of an Employee. - Add
POST /job_architecture/export/jobs/skill_profiles
endpoint to paginate through all Skill Profiles of Jobs in the API in bulk. - Add
POST /job_architecture/export/job_families/skill_profiles
endpoint to paginate through all Skill Profiles of Job Families in the API in bulk. - Add support for
ticket
Skill Events. - Add support for
skill_notes
Job Profile Data. - Deprecated the
POST /job_architecture/export/job/skill_clusters
endpoint and added thePOST /job_architecture/export/jobs/skill_clusters
.
January 2024
- A
source
attribute can now be added to each Skill Profile feedback endpoint to indicate the source of the feedback. See allPATCH /{entity}/{entity_id}/skill_profile
endpoints. - An
include
query parameter can now be added to theGET /employees/{external_id}/skill_profile
endpoint to include the source Skill Events where the reported Skills are inferred from. - Add
POST /export/employees/skill_profiles
endpoint to get the Skill profiles of all Employees in the API through pagination. - Add the
POST /skills/lookup
endpoint to get corresponding UUIDs for a list of Skill names. - Add
GET /job_architecture/job/{job_id}/suggested_skill_profile
to get suggested skills for a Job. - Add
GET /job_architecture/job_families/{job_family_id}/suggested_skill_profile
to get suggested skills for a Job Family.
December 2023
- Add the
include=custom_properties
query parameter to theGET /taxonomy/skills/{skill_id}
endpoint to include the Custom Properties of a Skill in the response. - Add the
include=custom_properties
query parameter to theGET /taxonomy/skill_clusters/{skill_cluster_id}
endpoint to include the Custom Properties of Skill Clusters in the response. - Add the
include=custom_properties
query parameter to theGET /taxonomy/subdomains/{subdomain_id}
endpoint to include the Custom Properties of Subdomains in the response. - Add the
include=custom_properties
query parameter to theGET /taxonomy/domains/{domain_id}
endpoint to include the Custom Properties of Domains in the response. - Introduced a
skill_id
field alongside Skill names in our API endpoints to avoid ambiguities and conflicts. All endpoints that return Skill names will now also return askill_id
field. Using Skill names in a request body to denote an update of a Skill is deprecated, please useskill_id
instead. - Mark all
/occupations
endpoints as deprecated. - Add the
vocab_language
query parameter to theGET /{entity}/{external_id}/skill_profile
endpoints to specify the language of the Skill names in the Skill Profile response. - Add the
vocab_language
query parameter to theGET /taxonomy/skill_clusters/{external_id}/skills
endpoint to specify the language of the Skill names in the Skill Profile response. - Add the
vocab_language
query parameter to theGET /taxonomy/skill/
endpoints to specify the language of the Skill names in the Skill Profile response. - Add the
vocab_language
query parameter to theGET /taxonomy/export/
endpoints to specify the language of the Skill names in the Skill Profile response.
November 2023
- Add the
domain_namespace
query parameter toGET /job_architecture/jobs/{job_external_id}/skill_profile
endpoint to express the Skill Domains in either TechWolf or Taxonomy Domains. - Add the
domain_namespace
query parameter toGET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint to express the Skill Domains in either TechWolf or Taxonomy Domains. - Add the
domain_namespace
query parameter toGET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoint to express the Skill domains in either TechWolf or Taxonomy Domains. - Add
domain_name
response body field anddomain_namespace
query parameter toGET /taxonomy/skills/{skill_id}
endpoint to express the Skill Domains in either TechWolf or Taxonomy Domains. - Add
domain_name
response body field anddomain_namespace
query parameter toGET /taxonomy/skills
endpoint to express the Skill Domains in either TechWolf or Taxonomy Domains. - Add the
domain_namespace
query parameter toGET /skills/search
endpoint to express the Skill Domains in either TechWolf or Taxonomy Domains. - Add
POST /export/courses/skill_profiles
endpoint to paginate through all Skill Profiles of Courses in the API in bulk. - Add
last_updated_with_taxonomy_changes
filter to the POST/export/employees/skill_clusters
and POST/job_architecture/export/job/skill_clusters
endpoints. - Add
next_starting_after
field to response ofPOST /export/employees/skill_clusters
endpoint.
October 2023
- Add
GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint to get the market Skill Profile of a Job. - Update request sample for
POST /reports/job_architecture_benchmark
endpoint. - Mark all
/skill_clusters
endpoints as deprecated.
September 2023
- Add
skill_description
response body field and query parameterinclude=skill_description
toGET 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
andskill_sources
to Skills of response body field inGET export/employees/skill_clusters
. - Add a
POST /job_architecture/export/job/skill_clusters
endpoint to fetch Job Skill clusters and Skills in bulk. - Add the
Subdomain
entity to enable a 4-level Taxonomy hierarchy. - Add CRUD operations for Custom Properties and Custom Property Definitions
for the following Taxonomy entities:
taxonomy/domains
,taxonomy/subdomains
,taxonomy/skill_clusters
, andtaxonomy/skills
. - Add
external_id
andskill_vocab
fields to thetaxonomy/export
andtaxonomy/skill_cluster/<skill_custer_id>/skills
endpoints.
August 2023
- Add
skill_id
response body field and query parametersearch_method
toPOST skills/search
. - Add
GET
andPOST /taxonomy/domains
to see all Domains and create a new Domain respectively. AddGET
,PATCH
andDELETE /taxonomy/domains/{external_id}
to see a single Domain, update a Domain and delete a Domain respectively. - Add
GET
andPOST /taxonomy/skill_clusters
to see all Skill Clusters and create a new Skill Cluster respectively. AddGET
,PATCH
andDELETE /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. AddPUT
andDELETE /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}
andGET /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 ofGET job_architecture/jobs/{job_external_id}/skill_profile
andGET 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 askill_cluster_id
. - Add
GET /job_architecture/export
.
July 2023
- Add
POST /reports/job_architecture_benchmark
. - Add the
include=skill_match_scores
query parameter to thePOST /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
andGET /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
andPUT /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 thelast_updated
field is allowed. - Add the
used_event_types
body parameter to thePOST /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 typeskill_notes
. - Add progress to the
POST /reports/skill_inventory
endpoint. - Add
skill_cluster_id
to the output of Employee, Vacancy, Course, OccupationGET /{entity}/{external_id}/skill_profile?response_format=skill_clusters
endpoints, thePOST /export/employees/skill_clusters
endpoint, and thePOST /vacancies/{external_id}/matching_employees?include=skill_clusters
endpoint. - Add
POST /employees/{employee_external_id}/interactions
andDELETE /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
andPATCH /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
andjob_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
andjob_architecture/jobs/{job_external_id}/profile_data
endpoints respectively. - Add
custom_property_is_in_list
filter toPOST employees/{employee_external_id}/recommended_courses
. - Add the
property_value
andassigned_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
andGET job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints - Add
match_feedback
option for theinclude
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 theGET job_architecture/jobs/{job_external_id}
andGET 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
atPOST /employees/{employee_external_id}/skill_events
andPATCH /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 thePOST /export/employees/skill_clusters
endpoint. - Add the option to create learning Skill Events from a
course_id
January 2023
- Add
competency_type
inGET /competencies
andGET /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
withresponse_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 toPOST employees/{employee_external_id}/recommended_courses
andPOST employees/{employee_external_id}/matching_vacancies
- Add
DELETE
endpoints toemployees/{employee_external_id}/vacancies/{vacancy_external_id}/match_feedback
andemployees/{employee_external_id}/courses/{course_external_id}/match_feedback
- Add
include=competencies
query parameter tovacancies/{vacancy_external_id}/matching_employees
. - Add
include
query parameter for theemployees/{employee_external_id}/similar
endpoint. Possible values are:entity
,competencies
andcustom_properties
. - Add
validation_state
to Skills returned fromGET employees/{employee_external_id}/skill_profile
endpoint inlist
andcompetency
format. - Add
validation_state
to Skills returned fromPOST export/employees/competencies
endpoint. - Add
exclude_match_feedback
filter to theemployees/search
andvacancies/search
endpoints. - Add
related_skills
toinclude
inPOST export/employees/competencies
endpoint. - Adding a
proficiency_level
to a competency in the body is no longer required when sending feedback viaPUT
orPATCH
to/employees/{employee_external_id}/skill_profile?feedback_format=competencies
- Add
score_breakdown
option for theinclude
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 tovacancies/{external_id}/skill_profile
,occupations/{external_id}/skill_profile
andcourses/{external_id}/skill_profile
. - Add
include=relevant_experience
query parameter toemployees/{employee_external_id}/matching_vacancies
andvacancies/{vacancy_external_id}/matching_employees
. - For
LocationAddress
inputs,city
can be used instead ofpostal_code
now, making one of them required instead of havingpostal_code
required. - The Get Skill Profile endpoints
/entity_type/{ID}/skill_profile
withresponse_format=competencies
now return Skill category information.
October 2022
- Add a not equals option (
neq
) to thecustom_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 tovacancies/{vacancy_external_id}/matching_employees
to allow retrieving Employee information without extra calls. - Add
include=location
query parameter option toemployees/{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
andPATCH /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
andcertificate
Skill Events. - Add support for explicit
working_history
,education_history
, andresume_document
Skill Events.
March 2022
- Add support for
feedback
andgoal
Skill Events.
February 2022
- Add
include
query parameter toemployees/{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 alearning_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 alearning_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
andcustom_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 supportresponse_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 withresponse_format=explained
query parameter now returns the body with missing Skills included under themissing_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 thePUT
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
andvacancies/{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 theequals
operator. - You can now specify an offset on matching endpoints for
employees
,vacancies
andcompanies
. - You can now specify an offset on search endpoints for
employees
,vacancies
andcompanies
. - You can now pass the
null
value for optional fields during creation and updating of all entities. Passing thenull
value during an update will unset the entity’s attribute. Objects will be unset asnull
, 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
andcompanies/{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
andcompanies/{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 attributecompany
. - 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 valuefalse
, 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
andvacancies/{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
andvacancies/{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
andmatching_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 areauto
,nl
,fr
anden
. - 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 nomax_geo_distance
. provided as query parameter. The default distance in our system when nothing is provided, is 50 km.
Was this page helpful?