The list below gives a sorted overview of non-breaking changes to the SkillEngine API. These changes are immediately available to you and will be supported by your API, regardless of your version.
include
parameter in theGET /employees/{employee_external_id}/skill_profile
endpoint to allow inferred_proficiency_level
and inferred_proficiency_float
to be included with response_format=list
.include
body parameter in thePOST export/employees/skill_profiles
endpoint to allow the self_rated_proficiency_level
,
self_rated_proficiency_float
,inferred_proficiency_level
and inferred_proficiency_float
fields to be included.GET /job_architecture/issues
endpoint to fetch Job issues.GET /job_architecture/issues/summary
endpoint to get a summary of the number of Job issues per type.include=issues
parameter to the GET /job_architecture/export
endpoint.GET /job_architecture/changes
endpoint to fetch Job architecture changes.PATCH /job_architecture/changes
endpoint to bulk update multiple job architecture changes at once.GET /job_architecture/changes/summary
endpoint to get a summary of the number of Job changes per type.GET /job_architecture/changes/{change_id}
endpoint to get detailed information about a specific Job architecture change.PATCH /job_architecture/changes/{change_id}
endpoint to update a specific Job architecture change with new data.self_rated_proficiency_level
and self_rated_proficiency_float
attributes to the request body of the
PATCH /employees/{employee_external_id}/skill_profile
endpoint for the
skills
and external_vendor_skills
feedback formats.include
parameter in the
GET /employees/{employee_external_id}/skill_profile
endpoint to allow
self_rated_proficiency_level
and self_rated_proficiency_float
to be
included with response_format=list
.GET /job_architecture/jobs/market_alignment
and
POST job_architecture/export/jobs/market_alignment
endpoints.ticket_system
field to the ticket
event type to be able to specify
the ticketing system where the ticket originated from. This field is
important for skill inference as different models may be used for different
ticketing systems.parent_id=null
to become a
root Organisational Unit in the PATCH /organisational_units/{external_id}
endpoint.GET /job_architecture/peer_groups
endpoint.proficiency_float
field to the request body of the
PATCH /job_architecture/jobs/{job_external_id}/skill_profile
and
PATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.include=proficiency_float
option to the include query parameter of
the GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.include=proficiency_float
option to the include body parameter of
the POST /job_architecture/export/jobs/skill_profiles
and
POST /job_architecture/export/job_families/skill_profiles
endpoints.external_vendor
query parameter to the
POST /employees/suggestions/skills
endpointstrict
query parameter from the
POST /employees/suggestions/skills
endpointinclude=critical
option to the include query parameters to the
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
endpoint.include
parameter in the
GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints to allow proficiency_level
and critical
to be included with
response_format=hierarchy
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.include=proficiency_level
and include=critical
options to the
include body parameter of the
POST /job_architecture/export/jobs/skill_profiles
endpoint.include=proficiency_level
and include=critical
options to the
include body parameter of the
POST /job_architecture/export/job_families/skill_profiles
endpoint.external_vendor
query parameter to the GET /skills/search
endpoint.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
,
and POST /job_architecture/export/job_families/skill_profiles
endpoints.force_recalculate
query parameter to all report endpoints.limit
, offset
, and update_low_data_availability
query parameters
to the GET /reports/data_maturity_scan/employee_maturity_overview
and
GET /reports/data_maturity_scan/job_maturity_overview
endpoints.include=skill_cluster_description
parameter to the
GET /taxonomy/skill_clusters
endpoint.skill_cluster_description
response body field and query parameter
include=skill_cluster_description
to the GET taxonomy/export
endpoint.PATCH /taxonomy/skills/{skill_id}
endpoint.GET /taxonomy/skills
,
GET /taxonomy/skills/{skill_id}
, and GET /taxonomy/export
endpoints if
one is set.update_skill
operation type to the GET /taxonomy/changes
and
POST /taxonomy/apply
endpoints.include=skill_description
parameter to the
/taxonomy/skill_clusters/{skill_cluster_external_id}/skills
endpoint.GET /job_architecture/jobs/{job_external_id}/market_skill_profiles
and
POST /job_architecture/export/jobs/market_skill_profiles
endpoints.proficiency_level
and critical
attributes to the request body of
the PATCH /job_architecture/jobs/{job_external_id}/skill_profile
endpoint.proficiency_level
and critical
attributes to the request body of
the
PATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoint.include=proficiency_level
and include=critical
query parameters
to the GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.POST /job_architecture/jobs/metrics/adoption_metrics
endpoint.POST /employees/metrics/adoption_metrics
endpoint.source_data
to skills
returned in
GET/job_architecture/jobs/{job_external_id}/skill_profile
and
GET/job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.active
attribute to the Organisational Unit entity.hierarchy
as a possible response format for the
GET /employees/{employee_external_id}/skill_profile
endpoint.include=custom_properties
parameter to
GET/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
and GET/taxonomy/skills
endpoints.output_skills_sorting
parameter to
GET /job_architecture/export/job_families/suggested_skill_profiles
,
GET /job_architecture/export/job_families/skill_profiles
,
GET /job_architecture/export/jobs/suggested_skill_profiles
and
GET /job_architecture/export/jobs/skill_profiles
endpoints.GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint.vocab_update_rename_skill
, vocab_update_merge_skill
, and
vocab_update_remove_skill
operation types to the GET /taxonomy/changes
endpoint.GET /job_architecture/jobs/{job_external_id}/matching_source_jobs
endpoint.GET /job_architecture/jobs/{job_external_id}/matching_target_jobs
endpoint.DELETE /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
for
DELETE /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 thisGET /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
endpoint.skill_profile_feedback
as a data_type
to the Job Family Profile Data
of a Job Family. This new data_type
may be included the responses of
GET /job_architecture/job_families/{job_family_external_id}/profile_data
and
GET /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
.GET /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
endpoint.skill_profile_feedback
as a data_type
to the Job Profile Data of a
Job. This new data_type
may be included the responses of
GET /job_architecture/jobs/{job_external_id}/profile_data
and
GET /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
.skill_id
query parameter to the GET /employees
and
GET /organisational_units/export
endpoints that allows for filtering the
returned entities on whether their Skill Profile contains a certain Skill.POST /employees/suggestions/skill
endpoint that allows
to find suggested, validated, and rejected Skill suggestions for Employees.en_us
, de
, and fr
to the list of supported values for the
vocab_language
query parameters in the
GET /{entity}/{external_id}/skill_profile
,
GET /taxonomy/skill_clusters/{external_id}/skills
, GET /taxonomy/skill/
,
and GET /taxonomy/export/
endpoints.low_data_availability_flag
to the possible values of the include
query parameter of the GET /organisational_units/export
and
GET /job_architecture/export
endpoints.skill_id
query parameter to the GET /job_architecture/export
endpoint that allows for filtering the entities on whether their Skill
Profile contains a certain Skill.source_coverage
metric to the response of the
GET /reports/data_maturity_scan/job_quality_matrix
and
GET /reports/data_maturity_scan/employee_quality_matrix
endpoints.skill_name
, skill_cluster_name
, subdomain_name
, and domain_name
to the output of GET /taxonomy/changes
.subdomain_name
to output of the
POST /job_architecture/export/jobs/skill_clusters
,
POST /export/employees/skill_clusters
and
GET /employees/<employee_id>/skill_profile?response_format=skill_clusters
endpoints for 4-level Taxonomies.source_data
to the output of
GET /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
, and
POST /job_architecture/export/job_families/suggested_skill_profiles
.POST /integrations/file_load_task
to upload a CSV-file from
S3 into the system and GET /integrations/file_load_task/{task_id}
to get
the status of the File Load Task.skill_validation_state
to the possible values of the include
query
parameter of the GET /job_architecture/export/jobs/skill_profiles
,
GET /job_architecture/export/jobs/suggested_skill_profiles
,
GET /job_architecture/export/job_families/skill_profiles
, and
GET /job_architecture/export/job_families/suggested_skill_profiles
endpoints.skill_validation_state
to the possible values of the include
query
parameter of the
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/suggested_skill_profile
endpoints.skill_validation_state
to the possible values of the include
query
parameter of the
GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
endpoints.GET /reports/employees/key_metrics
GET /reports/jobs/key_metrics
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
GET /organisational_units/export
to get the full
hierarchy of the Organisational Units including the total_nr_of_employees
field.organisational_unit
field to Employees that is returned in
GET /employees
and GET /employees/{external_id}
.organisational_unit
to GET /employees
to filter
Employees on their linked Organisational Unit.low_data_availability_flag
to the possible values of the
include
query parameter of the
GET /employees/{external_id}/skill_profile
and
GET /job_architecture/jobs/{job_external_id}/skill_profile
endpoints.low_data_availability_flag
to the possible values of the
include
body parameter of the POST /export/employees/skill_profiles
and
POST /job_architecture/export/jobs/skill_profiles
endpoints that allows
including the low data availability flag in the output.job_description
as Job
Profile Data. Available in the
POST /job_architecture/jobs/{job_external_id}/profile_data
and
PATCH /job_architecture/jobs/{job_external_id}/profile_data
endpoint.job_family_description
as
Job Family Profile Data. Available in the
POST /job_architecture/job_families/{job_family_external_id}/profile_data
and
PATCH /job_architecture/job_families/{job_family_external_id}/profile_data
endpoint.low_data_availability
attribute to the Employee entity.low_data_availability
attribute to the Job entity.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
rejected_skills
to the possible values of the include
body
parameter of the POST /export/employees/skill_profiles
endpoint that
allows including rejected Skills in the output.GET /employees/{employee_external_id}/jobs/{job_external_id}/match
endpoint that allows to match an Employee with a Job.POST /employees/{employee_external_id}/matching_jobs
endpoint that
allows to find the top matching Jobs for an Employee.POST /job_architecture/jobs/{external_id}/matching_employees
endpoint
that allows to find the top matching Employees for a Job.POST /job_architecture/job_families/{external_id}/matching_employees
endpoint that allows to find the top matching Employees for a Job Family.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.GET /employees/{employee_external_id}/job_families/{job_family_external_id}/match
endpoint that allows to match an Employee with a Job Family.GET /employees/{employee_external_id}/match_assigned_position
endpoint
that allows to match an Employee with their assigned position.POST /export/employees/match_assigned_position
endpoint that allows to
match Employees with their assigned position in bulk.output_skills_sorting
body parameter to the
POST /export/employees/skill_profiles
endpoint, allowing alphabetical
to
sort the Skills in the resulting profiles alphabetically, or confidence
to
sort them by decreasing confidence.is_active
filter to the
POST /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.is_active
query parameter to the GET /job_architecture/export
export
endpoint to only include active or inactive jobs and job families in the
result.is_active
query parameter to the GET /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.include=entity
and include=custom_properties
query parameter to
POST /employees/{external_id}/matching_job_families
.Core
as a possible value of the skill_type
field of a Skill in
the Job Family Skill Profile.response_format=explained
query parameter to
POST /employees/{external_id}/matching_vacancies
,
POST /vacancies/{external_id}/matching_employees
and
POST /employees/{external_id}/matching_job_families
, that includes
missing_skills
and present_skills
response body fields as additional
information about the matches.include=adoption
query parameter to the taxonomy/skills/{skill_id}
endpoint to include the adoption of the Skill in Jobs and Employees in the
response.assigned_position_id
attribute to the Employee entity.PATCH /employees/<employee_id>/skill_events/<event_id>
on the
resume_document
, feedback
, goal
, project
, certificate
, learning
and ticket
event types.active
attribute to Course, Employee, Job and Job Family entity.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}
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
GET /employee{employee_external_id}/vacancy/{vacancy_external_id}/recommend_courses
POST /employee{employee_external_id}/vacancy/{vacancy_external_id}/recommend_courses
endpoint which makes use of an updated and improved methodology to recommend
Courses.POST /employee{employee_external_id}/recommend_courses
endpoint in
line with the updated and improved methodology to recommend Courses.POST /job_architecture/export/jobs/suggested_skill_profiles
endpoint
to paginate through all suggested Skill Profiles of Jobs in the API in bulk.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.domain_namespace
query parameter is available on the
job_architecture/export/jobs/skill_profiles
and
job_architecture/export/job_families/skill_profiles
endpoints.GET /employee/{employee_id}/skill_profile
or
POST /export/employees/skill_profiles
, the response will now include the
source_events
field on all Skills, when requesting sources.
source_events
provides more insights into which Skill Event contributes to
which skill.GET /employees/{employee_id}/skill_events/{skill_event_id}
endpoint to
be able to get a single Skill Event of an Employee.POST /job_architecture/export/jobs/skill_profiles
endpoint to paginate
through all Skill Profiles of Jobs in the API in bulk.POST /job_architecture/export/job_families/skill_profiles
endpoint to
paginate through all Skill Profiles of Job Families in the API in bulk.ticket
Skill Events.skill_notes
Job Profile Data.POST /job_architecture/export/job/skill_clusters
endpoint
and added the POST /job_architecture/export/jobs/skill_clusters
.source
attribute can now be added to each Skill Profile feedback
endpoint to indicate the source of the feedback. See all
PATCH /{entity}/{entity_id}/skill_profile
endpoints.include
query parameter can now be added to the
GET /employees/{external_id}/skill_profile
endpoint to include the source
Skill Events where the reported Skills are inferred from.POST /export/employees/skill_profiles
endpoint to get the Skill
profiles of all Employees in the API through pagination.POST /skills/lookup
endpoint to get corresponding UUIDs for a list
of Skill names.GET /job_architecture/job/{job_id}/suggested_skill_profile
to get
suggested skills for a Job.GET /job_architecture/job_families/{job_family_id}/suggested_skill_profile
to get suggested skills for a Job Family.include=custom_properties
query parameter to the
GET /taxonomy/skills/{skill_id}
endpoint to include the Custom Properties
of a Skill in the response.include=custom_properties
query parameter to the
GET /taxonomy/skill_clusters/{skill_cluster_id}
endpoint to include the
Custom Properties of Skill Clusters in the response.include=custom_properties
query parameter to the
GET /taxonomy/subdomains/{subdomain_id}
endpoint to include the Custom
Properties of Subdomains in the response.include=custom_properties
query parameter to the
GET /taxonomy/domains/{domain_id}
endpoint to include the Custom
Properties of Domains in the response.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 a skill_id
field. Using Skill names in a request body to
denote an update of a Skill is deprecated, please use skill_id
instead./occupations
endpoints as deprecated.vocab_language
query parameter to the
GET /{entity}/{external_id}/skill_profile
endpoints to specify the
language of the Skill names in the Skill Profile response.vocab_language
query parameter to the
GET /taxonomy/skill_clusters/{external_id}/skills
endpoint to specify the
language of the Skill names in the Skill Profile response.vocab_language
query parameter to the GET /taxonomy/skill/
endpoints to specify the language of the Skill names in the Skill Profile
response.vocab_language
query parameter to the GET /taxonomy/export/
endpoints to specify the language of the Skill names in the Skill Profile
response.domain_namespace
query parameter to
GET /job_architecture/jobs/{job_external_id}/skill_profile
endpoint to
express the Skill Domains in either TechWolf or Taxonomy Domains.domain_namespace
query parameter to
GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint
to express the Skill Domains in either TechWolf or Taxonomy Domains.domain_namespace
query parameter to
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoint to express the Skill domains in either TechWolf or Taxonomy
Domains.domain_name
response body field and domain_namespace
query parameter
to GET /taxonomy/skills/{skill_id}
endpoint to express the Skill Domains
in either TechWolf or Taxonomy Domains.domain_name
response body field and domain_namespace
query parameter
to GET /taxonomy/skills
endpoint to express the Skill Domains in either
TechWolf or Taxonomy Domains.domain_namespace
query parameter to GET /skills/search
endpoint
to express the Skill Domains in either TechWolf or Taxonomy Domains.POST /export/courses/skill_profiles
endpoint to paginate through all
Skill Profiles of Courses in the API in bulk.last_updated_with_taxonomy_changes
filter to the POST
/export/employees/skill_clusters
and POST
/job_architecture/export/job/skill_clusters
endpoints.next_starting_after
field to response of
POST /export/employees/skill_clusters
endpoint.GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint to get the market Skill Profile of a Job.POST /reports/job_architecture_benchmark
endpoint./skill_clusters
endpoints as deprecated.skill_description
response body field and query parameter
include=skill_description
to GET taxonomy/export
.vacancy
data type for Job Profile Data. Available in the POST
/job_architecture/jobs/{job_external_id}/profile_data
endpoint.taxonomy/changes
endpoint to view all changes to the Taxonomy
within a certain timeframe.skill_id
and skill_sources
to Skills of response body field in
GET export/employees/skill_clusters
.POST /job_architecture/export/job/skill_clusters
endpoint to fetch
Job Skill clusters and Skills in bulk.Subdomain
entity to enable a 4-level Taxonomy hierarchy.taxonomy/domains
,
taxonomy/subdomains
, taxonomy/skill_clusters
, and taxonomy/skills
.external_id
and skill_vocab
fields to the taxonomy/export
and
taxonomy/skill_cluster/<skill_custer_id>/skills
endpoints.skill_id
response body field and query parameter search_method
to
POST skills/search
.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.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.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.GET /taxonomy/skills/{concept_uuid}
and GET /taxonomy/skills
to get
meta information of a single Skill or multiple Skills.GET /taxonomy/export
to export the full structure of the Taxonomy.POST /taxonomy/apply
to apply a set of changes to the Taxonomy.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
.PATCH /employees/{external_id}/skill_profile?feedback_format=skill_clusters
)
can now be given with a skill_cluster_id
.GET /job_architecture/export
.POST /reports/job_architecture_benchmark
.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.POST /reports/internal_talent_mobility
.POST /reports/skill_inventory
.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.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.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.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.PATCH
on SkillEvents with type skill_notes
.POST /reports/skill_inventory
endpoint.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.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.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./companies/search
endpoint.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.POST /reports/skill_inventory
endpoint to get the Skill Inventory
report./employees/{employee_external_id}/skill_events/{skill_event_external_id}
endpoint to support updating an Employee’s Skill Event.job_architecture/jobs
and
job_architecture/job_families
endpoints respectively.job_architecture/job_families/{job_family_external_id}/profile_data
and
job_architecture/jobs/{job_external_id}/profile_data
endpoints
respectively.custom_property_is_in_list
filter to
POST employees/{employee_external_id}/recommended_courses
.property_value
and assigned_position
fields of an Employee to
the Skill Cluster Adoption report
(reports/employees/skill_cluster_adoption
).GET job_architecture/jobs/{job_external_id}/skill_profile
and
GET job_architecture/job_families/{job_family_external_id}/skill_profile
endpointsmatch_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
include option when
sending to the GET job_architecture/jobs/{job_external_id}
and
GET job_architecture/job_families/{job_family_external_id}
endpoints./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.job_id
at
POST /employees/{employee_external_id}/skill_events
and
PATCH /employees/{employee_external_id}/skill_events/{skill_event_external_id}
respectively/employees/{external_id}/matching_vacancies
and
/vacancies/{external_id}/matching_employees
./reports/succession_risk
endpoint.rejected_skills
include option to the
POST /export/employees/skill_clusters
endpoint.course_id
competency_type
in GET /competencies
and
GET /competencies/{external_id}
./reports/replacement_risk
endpoint./entity_type/{external_id}/skill_profile
with response_format=competencies
now return Skill information.custom_property_list_overlap
filter for Employee and Vacancy matching.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.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.exclude_match_feedback
filter to
POST employees/{employee_external_id}/recommended_courses
and
POST employees/{employee_external_id}/matching_vacancies
DELETE
endpoints to
employees/{employee_external_id}/vacancies/{vacancy_external_id}/match_feedback
and
employees/{employee_external_id}/courses/{course_external_id}/match_feedback
include=competencies
query parameter to
vacancies/{vacancy_external_id}/matching_employees
.include
query parameter for the
employees/{employee_external_id}/similar
endpoint. Possible values are:
entity
, competencies
and custom_properties
.validation_state
to Skills returned from
GET employees/{employee_external_id}/skill_profile
endpoint in list
and
competency
format.validation_state
to Skills returned from
POST export/employees/competencies
endpoint.exclude_match_feedback
filter to the employees/search
and
vacancies/search
endpoints.related_skills
to include
in POST export/employees/competencies
endpoint.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
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.skill_notes
event type./reports/employees/competency_adoption
endpoint.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.PATCH
endpoint to vacancies/{external_id}/skill_profile
,
occupations/{external_id}/skill_profile
and
courses/{external_id}/skill_profile
.include=relevant_experience
query parameter to
employees/{employee_external_id}/matching_vacancies
and
vacancies/{vacancy_external_id}/matching_employees
.LocationAddress
inputs, city
can be used instead of postal_code
now, making one of them required instead of having postal_code
required./entity_type/{ID}/skill_profile
with
response_format=competencies
now return Skill category information.neq
) to the custom_property
filter.sources
in the /export/employees/competencies
endpoint, to be able
to track from which Skill Events the given competencies originate from.include
query parameter to
vacancies/{vacancy_external_id}/matching_employees
to allow retrieving
Employee information without extra calls.include=location
query parameter option to
employees/{employee_external_id}/matching_vacancies
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.POST /competencies
and
PATCH /competencies/{external_id}
endpoints to change the category of a
competency.last_updated
filter for Employee and Vacancy matching.POST /export/employees/competencies
endpoint for
extracting Employee competencies and Skills from the API.GET /competencies/{external_id}/skill_profile
endpoint
returns Skill Profiles for clients who use a Taxonomy managed by TechWolf.project
and certificate
Skill Events.working_history
, education_history
, and
resume_document
Skill Events.feedback
and goal
Skill Events.include
query parameter to
employees/{employee_external_id}/recommended_courses
to allow retrieving
Course information without extra calls./employees/{employee_external_id}/skill_events/{skill_event_external_id}
endpoint to support removing an Employee’s Skill Event from the API./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
./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
./employees/{employee_external_id}/recommended_courses
endpoint,
returning the recommended Courses to improve an Employee’s Skill Profile.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.language
weight configurations.
Match scores are increased when the matching entities’ language levels fall
between a range of the source entity language levels.explained
response format now return
additional category information when the explained response format is
requested./entity_type/{ID}/skill_profile
now
support response_format=categories
and thereby return Skill category
information./skills/search
now returns Skill category
information.de
) language.language=de
query parameter./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./companies/{external_id}/nace
endpoint./reports/reskilling_and_deployment
endpoint.score_min_threshold
.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.language
query parameter, to
indicate the language of the input text.companies/:external_id/desired_functions
now supports the PUT
method.
Calling this method replaces all existing desired function Vacancies with
the new set.score_min_threshold
.max_geo_distance
field on Employee entities was deprecated.max_geo_distance
field on Employee entities.companies/{external_id}/desired_functions
endpoint.employees/{external_id}/matching_vacancies
and
vacancies/{external_id}/matching_employees
.request_format=free_text
query parameter on the
/companies/{external_id}/desired_functions
endpoint.desired_functions
&
non_desired_functions
attributes./vacancies/search
and /companies/search
./employees/search
, /vacancies/search
and
/companies/search
.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.custom_property
filter. If no operator is specified, the filter defaults to the equals
operator.employees
,vacancies
and companies
.employees
,vacancies
and companies
.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 ''
.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.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)./employees/search
./vacancies
and attribute company
./companies/*
.active
.
When this is field has the value false
, the Vacancy will not be used for
matching./companies/{external_id}/matching_employees
./employees/{external_id}/matching_companies
./companies/{external_id}/desired_functions
.last_updated
upon entity retrieval.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.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).matching_vacancies
and matching_employees
are
now the preferred way to request the matches.language
query parameter.
Supported languages are auto
, nl
, fr
and en
.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.The list below gives a sorted overview of non-breaking changes to the SkillEngine API. These changes are immediately available to you and will be supported by your API, regardless of your version.
include
parameter in theGET /employees/{employee_external_id}/skill_profile
endpoint to allow inferred_proficiency_level
and inferred_proficiency_float
to be included with response_format=list
.include
body parameter in thePOST export/employees/skill_profiles
endpoint to allow the self_rated_proficiency_level
,
self_rated_proficiency_float
,inferred_proficiency_level
and inferred_proficiency_float
fields to be included.GET /job_architecture/issues
endpoint to fetch Job issues.GET /job_architecture/issues/summary
endpoint to get a summary of the number of Job issues per type.include=issues
parameter to the GET /job_architecture/export
endpoint.GET /job_architecture/changes
endpoint to fetch Job architecture changes.PATCH /job_architecture/changes
endpoint to bulk update multiple job architecture changes at once.GET /job_architecture/changes/summary
endpoint to get a summary of the number of Job changes per type.GET /job_architecture/changes/{change_id}
endpoint to get detailed information about a specific Job architecture change.PATCH /job_architecture/changes/{change_id}
endpoint to update a specific Job architecture change with new data.self_rated_proficiency_level
and self_rated_proficiency_float
attributes to the request body of the
PATCH /employees/{employee_external_id}/skill_profile
endpoint for the
skills
and external_vendor_skills
feedback formats.include
parameter in the
GET /employees/{employee_external_id}/skill_profile
endpoint to allow
self_rated_proficiency_level
and self_rated_proficiency_float
to be
included with response_format=list
.GET /job_architecture/jobs/market_alignment
and
POST job_architecture/export/jobs/market_alignment
endpoints.ticket_system
field to the ticket
event type to be able to specify
the ticketing system where the ticket originated from. This field is
important for skill inference as different models may be used for different
ticketing systems.parent_id=null
to become a
root Organisational Unit in the PATCH /organisational_units/{external_id}
endpoint.GET /job_architecture/peer_groups
endpoint.proficiency_float
field to the request body of the
PATCH /job_architecture/jobs/{job_external_id}/skill_profile
and
PATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.include=proficiency_float
option to the include query parameter of
the GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.include=proficiency_float
option to the include body parameter of
the POST /job_architecture/export/jobs/skill_profiles
and
POST /job_architecture/export/job_families/skill_profiles
endpoints.external_vendor
query parameter to the
POST /employees/suggestions/skills
endpointstrict
query parameter from the
POST /employees/suggestions/skills
endpointinclude=critical
option to the include query parameters to the
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
endpoint.include
parameter in the
GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints to allow proficiency_level
and critical
to be included with
response_format=hierarchy
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.include=proficiency_level
and include=critical
options to the
include body parameter of the
POST /job_architecture/export/jobs/skill_profiles
endpoint.include=proficiency_level
and include=critical
options to the
include body parameter of the
POST /job_architecture/export/job_families/skill_profiles
endpoint.external_vendor
query parameter to the GET /skills/search
endpoint.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
,
and POST /job_architecture/export/job_families/skill_profiles
endpoints.force_recalculate
query parameter to all report endpoints.limit
, offset
, and update_low_data_availability
query parameters
to the GET /reports/data_maturity_scan/employee_maturity_overview
and
GET /reports/data_maturity_scan/job_maturity_overview
endpoints.include=skill_cluster_description
parameter to the
GET /taxonomy/skill_clusters
endpoint.skill_cluster_description
response body field and query parameter
include=skill_cluster_description
to the GET taxonomy/export
endpoint.PATCH /taxonomy/skills/{skill_id}
endpoint.GET /taxonomy/skills
,
GET /taxonomy/skills/{skill_id}
, and GET /taxonomy/export
endpoints if
one is set.update_skill
operation type to the GET /taxonomy/changes
and
POST /taxonomy/apply
endpoints.include=skill_description
parameter to the
/taxonomy/skill_clusters/{skill_cluster_external_id}/skills
endpoint.GET /job_architecture/jobs/{job_external_id}/market_skill_profiles
and
POST /job_architecture/export/jobs/market_skill_profiles
endpoints.proficiency_level
and critical
attributes to the request body of
the PATCH /job_architecture/jobs/{job_external_id}/skill_profile
endpoint.proficiency_level
and critical
attributes to the request body of
the
PATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoint.include=proficiency_level
and include=critical
query parameters
to the GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.POST /job_architecture/jobs/metrics/adoption_metrics
endpoint.POST /employees/metrics/adoption_metrics
endpoint.source_data
to skills
returned in
GET/job_architecture/jobs/{job_external_id}/skill_profile
and
GET/job_architecture/job_families/{job_family_external_id}/skill_profile
endpoints.active
attribute to the Organisational Unit entity.hierarchy
as a possible response format for the
GET /employees/{employee_external_id}/skill_profile
endpoint.include=custom_properties
parameter to
GET/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
and GET/taxonomy/skills
endpoints.output_skills_sorting
parameter to
GET /job_architecture/export/job_families/suggested_skill_profiles
,
GET /job_architecture/export/job_families/skill_profiles
,
GET /job_architecture/export/jobs/suggested_skill_profiles
and
GET /job_architecture/export/jobs/skill_profiles
endpoints.GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint.vocab_update_rename_skill
, vocab_update_merge_skill
, and
vocab_update_remove_skill
operation types to the GET /taxonomy/changes
endpoint.GET /job_architecture/jobs/{job_external_id}/matching_source_jobs
endpoint.GET /job_architecture/jobs/{job_external_id}/matching_target_jobs
endpoint.DELETE /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
for
DELETE /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 thisGET /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
endpoint.skill_profile_feedback
as a data_type
to the Job Family Profile Data
of a Job Family. This new data_type
may be included the responses of
GET /job_architecture/job_families/{job_family_external_id}/profile_data
and
GET /job_architecture/job_families/{job_family_external_id}/profile_data/{job_family_profile_data_external_id}
.GET /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
endpoint.skill_profile_feedback
as a data_type
to the Job Profile Data of a
Job. This new data_type
may be included the responses of
GET /job_architecture/jobs/{job_external_id}/profile_data
and
GET /job_architecture/jobs/{job_external_id}/profile_data/{job_profile_data_external_id}
.skill_id
query parameter to the GET /employees
and
GET /organisational_units/export
endpoints that allows for filtering the
returned entities on whether their Skill Profile contains a certain Skill.POST /employees/suggestions/skill
endpoint that allows
to find suggested, validated, and rejected Skill suggestions for Employees.en_us
, de
, and fr
to the list of supported values for the
vocab_language
query parameters in the
GET /{entity}/{external_id}/skill_profile
,
GET /taxonomy/skill_clusters/{external_id}/skills
, GET /taxonomy/skill/
,
and GET /taxonomy/export/
endpoints.low_data_availability_flag
to the possible values of the include
query parameter of the GET /organisational_units/export
and
GET /job_architecture/export
endpoints.skill_id
query parameter to the GET /job_architecture/export
endpoint that allows for filtering the entities on whether their Skill
Profile contains a certain Skill.source_coverage
metric to the response of the
GET /reports/data_maturity_scan/job_quality_matrix
and
GET /reports/data_maturity_scan/employee_quality_matrix
endpoints.skill_name
, skill_cluster_name
, subdomain_name
, and domain_name
to the output of GET /taxonomy/changes
.subdomain_name
to output of the
POST /job_architecture/export/jobs/skill_clusters
,
POST /export/employees/skill_clusters
and
GET /employees/<employee_id>/skill_profile?response_format=skill_clusters
endpoints for 4-level Taxonomies.source_data
to the output of
GET /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
, and
POST /job_architecture/export/job_families/suggested_skill_profiles
.POST /integrations/file_load_task
to upload a CSV-file from
S3 into the system and GET /integrations/file_load_task/{task_id}
to get
the status of the File Load Task.skill_validation_state
to the possible values of the include
query
parameter of the GET /job_architecture/export/jobs/skill_profiles
,
GET /job_architecture/export/jobs/suggested_skill_profiles
,
GET /job_architecture/export/job_families/skill_profiles
, and
GET /job_architecture/export/job_families/suggested_skill_profiles
endpoints.skill_validation_state
to the possible values of the include
query
parameter of the
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
and
GET /job_architecture/job_families/{job_family_external_id}/suggested_skill_profile
endpoints.skill_validation_state
to the possible values of the include
query
parameter of the
GET /job_architecture/jobs/{job_external_id}/skill_profile
and
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
endpoints.GET /reports/employees/key_metrics
GET /reports/jobs/key_metrics
GET /job_architecture/jobs/{job_external_id}/suggested_skill_profile
GET /organisational_units/export
to get the full
hierarchy of the Organisational Units including the total_nr_of_employees
field.organisational_unit
field to Employees that is returned in
GET /employees
and GET /employees/{external_id}
.organisational_unit
to GET /employees
to filter
Employees on their linked Organisational Unit.low_data_availability_flag
to the possible values of the
include
query parameter of the
GET /employees/{external_id}/skill_profile
and
GET /job_architecture/jobs/{job_external_id}/skill_profile
endpoints.low_data_availability_flag
to the possible values of the
include
body parameter of the POST /export/employees/skill_profiles
and
POST /job_architecture/export/jobs/skill_profiles
endpoints that allows
including the low data availability flag in the output.job_description
as Job
Profile Data. Available in the
POST /job_architecture/jobs/{job_external_id}/profile_data
and
PATCH /job_architecture/jobs/{job_external_id}/profile_data
endpoint.job_family_description
as
Job Family Profile Data. Available in the
POST /job_architecture/job_families/{job_family_external_id}/profile_data
and
PATCH /job_architecture/job_families/{job_family_external_id}/profile_data
endpoint.low_data_availability
attribute to the Employee entity.low_data_availability
attribute to the Job entity.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
rejected_skills
to the possible values of the include
body
parameter of the POST /export/employees/skill_profiles
endpoint that
allows including rejected Skills in the output.GET /employees/{employee_external_id}/jobs/{job_external_id}/match
endpoint that allows to match an Employee with a Job.POST /employees/{employee_external_id}/matching_jobs
endpoint that
allows to find the top matching Jobs for an Employee.POST /job_architecture/jobs/{external_id}/matching_employees
endpoint
that allows to find the top matching Employees for a Job.POST /job_architecture/job_families/{external_id}/matching_employees
endpoint that allows to find the top matching Employees for a Job Family.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.GET /employees/{employee_external_id}/job_families/{job_family_external_id}/match
endpoint that allows to match an Employee with a Job Family.GET /employees/{employee_external_id}/match_assigned_position
endpoint
that allows to match an Employee with their assigned position.POST /export/employees/match_assigned_position
endpoint that allows to
match Employees with their assigned position in bulk.output_skills_sorting
body parameter to the
POST /export/employees/skill_profiles
endpoint, allowing alphabetical
to
sort the Skills in the resulting profiles alphabetically, or confidence
to
sort them by decreasing confidence.is_active
filter to the
POST /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.is_active
query parameter to the GET /job_architecture/export
export
endpoint to only include active or inactive jobs and job families in the
result.is_active
query parameter to the GET /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.include=entity
and include=custom_properties
query parameter to
POST /employees/{external_id}/matching_job_families
.Core
as a possible value of the skill_type
field of a Skill in
the Job Family Skill Profile.response_format=explained
query parameter to
POST /employees/{external_id}/matching_vacancies
,
POST /vacancies/{external_id}/matching_employees
and
POST /employees/{external_id}/matching_job_families
, that includes
missing_skills
and present_skills
response body fields as additional
information about the matches.include=adoption
query parameter to the taxonomy/skills/{skill_id}
endpoint to include the adoption of the Skill in Jobs and Employees in the
response.assigned_position_id
attribute to the Employee entity.PATCH /employees/<employee_id>/skill_events/<event_id>
on the
resume_document
, feedback
, goal
, project
, certificate
, learning
and ticket
event types.active
attribute to Course, Employee, Job and Job Family entity.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}
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
GET /employee{employee_external_id}/vacancy/{vacancy_external_id}/recommend_courses
POST /employee{employee_external_id}/vacancy/{vacancy_external_id}/recommend_courses
endpoint which makes use of an updated and improved methodology to recommend
Courses.POST /employee{employee_external_id}/recommend_courses
endpoint in
line with the updated and improved methodology to recommend Courses.POST /job_architecture/export/jobs/suggested_skill_profiles
endpoint
to paginate through all suggested Skill Profiles of Jobs in the API in bulk.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.domain_namespace
query parameter is available on the
job_architecture/export/jobs/skill_profiles
and
job_architecture/export/job_families/skill_profiles
endpoints.GET /employee/{employee_id}/skill_profile
or
POST /export/employees/skill_profiles
, the response will now include the
source_events
field on all Skills, when requesting sources.
source_events
provides more insights into which Skill Event contributes to
which skill.GET /employees/{employee_id}/skill_events/{skill_event_id}
endpoint to
be able to get a single Skill Event of an Employee.POST /job_architecture/export/jobs/skill_profiles
endpoint to paginate
through all Skill Profiles of Jobs in the API in bulk.POST /job_architecture/export/job_families/skill_profiles
endpoint to
paginate through all Skill Profiles of Job Families in the API in bulk.ticket
Skill Events.skill_notes
Job Profile Data.POST /job_architecture/export/job/skill_clusters
endpoint
and added the POST /job_architecture/export/jobs/skill_clusters
.source
attribute can now be added to each Skill Profile feedback
endpoint to indicate the source of the feedback. See all
PATCH /{entity}/{entity_id}/skill_profile
endpoints.include
query parameter can now be added to the
GET /employees/{external_id}/skill_profile
endpoint to include the source
Skill Events where the reported Skills are inferred from.POST /export/employees/skill_profiles
endpoint to get the Skill
profiles of all Employees in the API through pagination.POST /skills/lookup
endpoint to get corresponding UUIDs for a list
of Skill names.GET /job_architecture/job/{job_id}/suggested_skill_profile
to get
suggested skills for a Job.GET /job_architecture/job_families/{job_family_id}/suggested_skill_profile
to get suggested skills for a Job Family.include=custom_properties
query parameter to the
GET /taxonomy/skills/{skill_id}
endpoint to include the Custom Properties
of a Skill in the response.include=custom_properties
query parameter to the
GET /taxonomy/skill_clusters/{skill_cluster_id}
endpoint to include the
Custom Properties of Skill Clusters in the response.include=custom_properties
query parameter to the
GET /taxonomy/subdomains/{subdomain_id}
endpoint to include the Custom
Properties of Subdomains in the response.include=custom_properties
query parameter to the
GET /taxonomy/domains/{domain_id}
endpoint to include the Custom
Properties of Domains in the response.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 a skill_id
field. Using Skill names in a request body to
denote an update of a Skill is deprecated, please use skill_id
instead./occupations
endpoints as deprecated.vocab_language
query parameter to the
GET /{entity}/{external_id}/skill_profile
endpoints to specify the
language of the Skill names in the Skill Profile response.vocab_language
query parameter to the
GET /taxonomy/skill_clusters/{external_id}/skills
endpoint to specify the
language of the Skill names in the Skill Profile response.vocab_language
query parameter to the GET /taxonomy/skill/
endpoints to specify the language of the Skill names in the Skill Profile
response.vocab_language
query parameter to the GET /taxonomy/export/
endpoints to specify the language of the Skill names in the Skill Profile
response.domain_namespace
query parameter to
GET /job_architecture/jobs/{job_external_id}/skill_profile
endpoint to
express the Skill Domains in either TechWolf or Taxonomy Domains.domain_namespace
query parameter to
GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint
to express the Skill Domains in either TechWolf or Taxonomy Domains.domain_namespace
query parameter to
GET /job_architecture/job_families/{job_family_external_id}/skill_profile
endpoint to express the Skill domains in either TechWolf or Taxonomy
Domains.domain_name
response body field and domain_namespace
query parameter
to GET /taxonomy/skills/{skill_id}
endpoint to express the Skill Domains
in either TechWolf or Taxonomy Domains.domain_name
response body field and domain_namespace
query parameter
to GET /taxonomy/skills
endpoint to express the Skill Domains in either
TechWolf or Taxonomy Domains.domain_namespace
query parameter to GET /skills/search
endpoint
to express the Skill Domains in either TechWolf or Taxonomy Domains.POST /export/courses/skill_profiles
endpoint to paginate through all
Skill Profiles of Courses in the API in bulk.last_updated_with_taxonomy_changes
filter to the POST
/export/employees/skill_clusters
and POST
/job_architecture/export/job/skill_clusters
endpoints.next_starting_after
field to response of
POST /export/employees/skill_clusters
endpoint.GET /job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint to get the market Skill Profile of a Job.POST /reports/job_architecture_benchmark
endpoint./skill_clusters
endpoints as deprecated.skill_description
response body field and query parameter
include=skill_description
to GET taxonomy/export
.vacancy
data type for Job Profile Data. Available in the POST
/job_architecture/jobs/{job_external_id}/profile_data
endpoint.taxonomy/changes
endpoint to view all changes to the Taxonomy
within a certain timeframe.skill_id
and skill_sources
to Skills of response body field in
GET export/employees/skill_clusters
.POST /job_architecture/export/job/skill_clusters
endpoint to fetch
Job Skill clusters and Skills in bulk.Subdomain
entity to enable a 4-level Taxonomy hierarchy.taxonomy/domains
,
taxonomy/subdomains
, taxonomy/skill_clusters
, and taxonomy/skills
.external_id
and skill_vocab
fields to the taxonomy/export
and
taxonomy/skill_cluster/<skill_custer_id>/skills
endpoints.skill_id
response body field and query parameter search_method
to
POST skills/search
.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.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.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.GET /taxonomy/skills/{concept_uuid}
and GET /taxonomy/skills
to get
meta information of a single Skill or multiple Skills.GET /taxonomy/export
to export the full structure of the Taxonomy.POST /taxonomy/apply
to apply a set of changes to the Taxonomy.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
.PATCH /employees/{external_id}/skill_profile?feedback_format=skill_clusters
)
can now be given with a skill_cluster_id
.GET /job_architecture/export
.POST /reports/job_architecture_benchmark
.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.POST /reports/internal_talent_mobility
.POST /reports/skill_inventory
.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.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.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.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.PATCH
on SkillEvents with type skill_notes
.POST /reports/skill_inventory
endpoint.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.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.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./companies/search
endpoint.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.POST /reports/skill_inventory
endpoint to get the Skill Inventory
report./employees/{employee_external_id}/skill_events/{skill_event_external_id}
endpoint to support updating an Employee’s Skill Event.job_architecture/jobs
and
job_architecture/job_families
endpoints respectively.job_architecture/job_families/{job_family_external_id}/profile_data
and
job_architecture/jobs/{job_external_id}/profile_data
endpoints
respectively.custom_property_is_in_list
filter to
POST employees/{employee_external_id}/recommended_courses
.property_value
and assigned_position
fields of an Employee to
the Skill Cluster Adoption report
(reports/employees/skill_cluster_adoption
).GET job_architecture/jobs/{job_external_id}/skill_profile
and
GET job_architecture/job_families/{job_family_external_id}/skill_profile
endpointsmatch_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
include option when
sending to the GET job_architecture/jobs/{job_external_id}
and
GET job_architecture/job_families/{job_family_external_id}
endpoints./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.job_id
at
POST /employees/{employee_external_id}/skill_events
and
PATCH /employees/{employee_external_id}/skill_events/{skill_event_external_id}
respectively/employees/{external_id}/matching_vacancies
and
/vacancies/{external_id}/matching_employees
./reports/succession_risk
endpoint.rejected_skills
include option to the
POST /export/employees/skill_clusters
endpoint.course_id
competency_type
in GET /competencies
and
GET /competencies/{external_id}
./reports/replacement_risk
endpoint./entity_type/{external_id}/skill_profile
with response_format=competencies
now return Skill information.custom_property_list_overlap
filter for Employee and Vacancy matching.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.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.exclude_match_feedback
filter to
POST employees/{employee_external_id}/recommended_courses
and
POST employees/{employee_external_id}/matching_vacancies
DELETE
endpoints to
employees/{employee_external_id}/vacancies/{vacancy_external_id}/match_feedback
and
employees/{employee_external_id}/courses/{course_external_id}/match_feedback
include=competencies
query parameter to
vacancies/{vacancy_external_id}/matching_employees
.include
query parameter for the
employees/{employee_external_id}/similar
endpoint. Possible values are:
entity
, competencies
and custom_properties
.validation_state
to Skills returned from
GET employees/{employee_external_id}/skill_profile
endpoint in list
and
competency
format.validation_state
to Skills returned from
POST export/employees/competencies
endpoint.exclude_match_feedback
filter to the employees/search
and
vacancies/search
endpoints.related_skills
to include
in POST export/employees/competencies
endpoint.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
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.skill_notes
event type./reports/employees/competency_adoption
endpoint.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.PATCH
endpoint to vacancies/{external_id}/skill_profile
,
occupations/{external_id}/skill_profile
and
courses/{external_id}/skill_profile
.include=relevant_experience
query parameter to
employees/{employee_external_id}/matching_vacancies
and
vacancies/{vacancy_external_id}/matching_employees
.LocationAddress
inputs, city
can be used instead of postal_code
now, making one of them required instead of having postal_code
required./entity_type/{ID}/skill_profile
with
response_format=competencies
now return Skill category information.neq
) to the custom_property
filter.sources
in the /export/employees/competencies
endpoint, to be able
to track from which Skill Events the given competencies originate from.include
query parameter to
vacancies/{vacancy_external_id}/matching_employees
to allow retrieving
Employee information without extra calls.include=location
query parameter option to
employees/{employee_external_id}/matching_vacancies
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.POST /competencies
and
PATCH /competencies/{external_id}
endpoints to change the category of a
competency.last_updated
filter for Employee and Vacancy matching.POST /export/employees/competencies
endpoint for
extracting Employee competencies and Skills from the API.GET /competencies/{external_id}/skill_profile
endpoint
returns Skill Profiles for clients who use a Taxonomy managed by TechWolf.project
and certificate
Skill Events.working_history
, education_history
, and
resume_document
Skill Events.feedback
and goal
Skill Events.include
query parameter to
employees/{employee_external_id}/recommended_courses
to allow retrieving
Course information without extra calls./employees/{employee_external_id}/skill_events/{skill_event_external_id}
endpoint to support removing an Employee’s Skill Event from the API./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
./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
./employees/{employee_external_id}/recommended_courses
endpoint,
returning the recommended Courses to improve an Employee’s Skill Profile.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.language
weight configurations.
Match scores are increased when the matching entities’ language levels fall
between a range of the source entity language levels.explained
response format now return
additional category information when the explained response format is
requested./entity_type/{ID}/skill_profile
now
support response_format=categories
and thereby return Skill category
information./skills/search
now returns Skill category
information.de
) language.language=de
query parameter./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./companies/{external_id}/nace
endpoint./reports/reskilling_and_deployment
endpoint.score_min_threshold
.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.language
query parameter, to
indicate the language of the input text.companies/:external_id/desired_functions
now supports the PUT
method.
Calling this method replaces all existing desired function Vacancies with
the new set.score_min_threshold
.max_geo_distance
field on Employee entities was deprecated.max_geo_distance
field on Employee entities.companies/{external_id}/desired_functions
endpoint.employees/{external_id}/matching_vacancies
and
vacancies/{external_id}/matching_employees
.request_format=free_text
query parameter on the
/companies/{external_id}/desired_functions
endpoint.desired_functions
&
non_desired_functions
attributes./vacancies/search
and /companies/search
./employees/search
, /vacancies/search
and
/companies/search
.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.custom_property
filter. If no operator is specified, the filter defaults to the equals
operator.employees
,vacancies
and companies
.employees
,vacancies
and companies
.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 ''
.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.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)./employees/search
./vacancies
and attribute company
./companies/*
.active
.
When this is field has the value false
, the Vacancy will not be used for
matching./companies/{external_id}/matching_employees
./employees/{external_id}/matching_companies
./companies/{external_id}/desired_functions
.last_updated
upon entity retrieval.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.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).matching_vacancies
and matching_employees
are
now the preferred way to request the matches.language
query parameter.
Supported languages are auto
, nl
, fr
and en
.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.