Breaking Changes
Below is a list of breaking changes in the TechWolf API. These changes will cause request with versions after the given date to fail, depending on what the breaking change was. Breaking changes that affect any customer will be first communicated with the customer; We do not release breaking changes without prior communication.
2025-03-05
- Removed the
skill_vocab
andexternal_id
fields from theGET /taxonomy/skills
endpoint - Removed the
skill_vocab
andexternal_id
fields from theGET /taxonomy/skills/{skill_id}
endpoint - Removed the
skill_vocab
andexternal_id
fields from theGET /taxonomy/skill_clusters/{skill_cluster_external_id}/skills
endpoint - Removed the
skill_vocab
andexternal_id
fields from theGET /taxonomy/export
endpoint
2025-02-14
- Removed the
POST /integrations/file_load_task
endpoint. - Removed the
GET /integrations/file_load_task/{task_id}
endpoint.
2025-02-06
- Removed the
/job_architecture/jobs/{job_external_id}/market_skill_profile
endpoint.
2025-01-16
- Removed the
response_format=trending
query paramter option for allGET /<entity>/skill_profile
endpoints.
2024-12-19
- Removed the
GET /employees/{external_id}/metrics/position_alignment
endpoint.
2024-11-20
- Removed the
POST /vacancies/{external_id}/metrics/fillability
endpoint.
2024-11-15
- Renamed the value of query parameter
include=description
toinclude=skill_description
in theGET /taxonomy/skills
endpoint.
2024-10-28
- Changed the format for duplicate data examples from the
GET /reports/data_maturity_scan/data_improvement_actions
endpoint.
2024-10-07
- Removed the
POST /reports/skills_alignment
endpoint. - Removed the
POST /reports/workforce_alignment
endpoint. - Removed the
POST /reports/strategy_map
endpoint. - Removed the
POST /reports/skill_frequencies
endpoint. - Removed the
POST /reports/organization_names
endpoint. - Removed the
POST /reports/employee_skill_distribution
endpoint. - Removed the
POST /reports/vacancy_skill_distribution
endpoint.
2024-09-20
- Renamed the field
name
toskill_name
in theGET /employees/{external_id}/skill_profile
endpoint when theresponse_format
query parameter is set toskill_clusters
ordomains
.
2024-08-29
- Removed the
GET /reports/succession_risk
endpoint.
2024-08-27
- Removed the
GET /reports/employees/skills
endpoint.
2024-08-21
- Removed the
GET /reports/employees/position_alignment
endpoint.
2024-08-20
- Removed the
POST /reports/replacement_risk
endpoint.
2024-08-19
- Removed
count
response body field from thePOST /employees/search
endpoint. - Removed
count
response body field from thePOST /vacancies/search
endpoint. - Removed
count
response body field from thePOST /companies/search
endpoint. - Removed
count
response body field from thePOST /employees/{external_id}/recommended_courses
endpoint. - Removed
count
response body field from thePOST /employees/{employee_external_id}/vacancies/{vacancy_external_id}/recommended_courses
endpoint. - Removed
count
response body field from thePOST /employees/{employee_external_id}/jobs/{job_external_id}/recommended_courses
endpoint. - Removed
count
response body field from thePOST /employees/{external_id}/matching_vacancies
endpoint. - Removed
count
response body field from thePOST /employees/{external_id}/matching_companies
endpoint. - Removed
count
response body field from thePOST /employees/{external_id}/matching_jobs
endpoint. - Removed
count
response body field from thePOST /employees/{external_id}/matching_job_families
endpoint. - Removed
count
response body field from thePOST /vacancies/{external_id}/matching_employees
endpoint. - Removed
count
response body field from thePOST /companies/{external_id}/matching_employees
endpoint. - Removed
count
response body field from thePOST /job_architecture/jobs/{external_id}/matching_employees
endpoint. - Removed
count
response body field from thePOST /job_architecture/job_families/{external_id}/matching_employees
endpoint.
2024-07-25
- Removed the
GET /reports/employees/employability
endpoint. - Removed the
GET /employees/{external_id}/metrics/employability
endpoint. - Removed the
GET /vacancies/{external_id}/metrics/fillability
endpoint.
2024-06-20
- Removed support for the
language
filter in thePOST /companies/{external_id}/matching_employees
endpoint.
2024-06-17
- Removed
feedback_format=skill_clusters
support for thePATCH /vacancies/{external_id}/skill_profile
endpoint. - Removed
feedback_format=skill_clusters
support for thePATCH /courses/{external_id}/skill_profile
endpoint. - Removed
response_format=skill_clusters
support for theGET /vacancies/{external_id}/skill_profile
endpoint. - Removed
response_format=skill_clusters
support for theGET /courses/{external_id}/skill_profile
endpoint. - Removed the
POST /reports/clustered_trending_skills
endpoint. - Removed the
POST /reports/emerging_skills
endpoint.
2024-06-12
- Removed the
POST /employees/{external_id}/similar
endpoint. - Removed the
POST /vacancies/{external_id}/similar
endpoint. - Removed the
POST /courses/{external_id}/similar
endpoint.
2024-06-03
- Removed Occupation entity and its functionalities, along with the Reskilling & Deployment report
2024-05-15
- Removed the
include=skill_match_scores
query parameter ofPOST /employees/{external_id}/matching_job_families
2024-05-13
- Replaced the
skill_type
field withskill_types
for theskills
response body field of theGET /job_architecture/job/{job_id}/skill_profile
andGET /job_architecture/job_families/{job_family_id}/skill_profile
endpoints. - Replaced the
skill_type
field withskill_types
for theskills
field of therecords
response body field of thePOST /job_architecture/export/jobs/skill_profiles
, andPOST /job_architecture/export/job_families/skill_profiles
endpoints. - Replaced the
skill_type
field withskill_types
for theskills
field ofskill_clusters
field of therecords
response body field of thePOST /job_architecture/export/jobs/skill_clusters
.
2024-02-05
- Removed the
include=skill_clusters
query parameter ofPOST /vacancies/{external_id}/matching_employees
andGET /employees/{employee_external_id}/vacancies/{vacancy_external_id}/match
. - Moved the
relevant_experience
response body field of theresponse_format=explained
query parameter to the newly addedinclude=relevant_experience
query parameter of theGET /employees/{employee_external_id}/vacancies/{vacancy_external_id}/match
endpoint. - Renamed the
skill
response body field toskill_name
of theGET employees/{external_id}/vacancies/{external_id}/gap
endpoint.
2024-01-24
- The
GET /job_architecture/job/{job_id}/skill_profile
endpoint has a new Skill type calledFamily-Specific
. - The
GET /job_architecture/job_families/{job_family_id}/skill_profile
endpoint has a new Skill type calledFamily-Specific
.
2023-12-18
- The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /employees/{external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /job_architecture/jobs/{job_external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /job_architecture/job_families/{job_family_external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /vacancies/{external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /courses/{external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /occupations/{external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /vacancies/{external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /courses/{external_id}/skill_profile
now requires either askill
or askill_id
, not both. - The
skills
request body field of theSkillProfileUpdateMessage
of the endpointPATCH /occupations/{external_id}/skill_profile
now requires either askill
or askill_id
, not both.
2023-11-09
- Removed the deprecated
GET /employees/{external_id}/profile/related
endpoint. - Removed the deprecated
POST /employees/{external_id}/profile/related
endpoint. - Removed the deprecated
GET /vacancies/{external_id}/profile/related
endpoint. - Removed the deprecated
POST /vacancies/{external_id}/profile/related
endpoint. - Removed the deprecated
GET /courses/{external_id}/profile/related
endpoint. - Removed the deprecated
POST /courses/{external_id}/profile/related
endpoint. - Removed the deprecated
GET /occupations/{external_id}/profile/related
endpoint. - Removed the deprecated
POST /occupations/{external_id}/profile/related
endpoint. - Removed the deprecated
GET /skills/{skill_name}/related
endpoint.
2023-10-10
- Remove
POST /skill_clusters
in favor ofPOST /taxonomy/skill_clusters
. - Remove
DELETE /skill_clusters/{skill_cluster_id}
in favor ofDELETE /taxonomy/skill_clusters/{skill_cluster_id}
. - Remove
PATCH /skill_clusters/{skill_cluster_id}
in favor ofPATCH /taxonomy/skill_clusters/{skill_cluster_id}
.
2023-06-13
- Removed the deprecated
PUT {entity}/{external_id}/skill_profile
endpoint.
2023-04-21
- A
skill_event
withproject_content
now assumes a textual description of a ticket from a ticketing system (e.g. Jira, Asana, Github issues, etc.). The previous functionality of general project descriptions is removed.
2023-02-21
- The
desired_functions
andnon_desired_functions
fields of the Employee have been changed from lists of titles to list of Function objects. A Function object consists of a Function title and a relative importance.
2023-01-27
- All instances of
competency
,competencies
or capitalized alternatives have been renamed toskill_cluster
andskill_clusters
, and their capitalized versions. - All instances of
category
,categories
or capitalized alternatives have been renamed todomain
anddomains
, and their capitalized versions.
2022-10-24
-
The
competency
andscore
fields inPUT, PATCH /{entity}/{external_id}/skill_profile
incompetencies
format are now renamed tocompetency_name
andproficiency_level
respectively. -
The
score
fields inPUT, PATCH /{entity}/{external_id}/skill_profile
inskills
format is replaced byhas_skill
which is a boolean instead of number.
2022-10-05
- The
competency
andscore
fields inGET /{entity}/{external_id}/skill_profile
incompetencies
format are now renamed tocompetency_name
andproficiency_level
respectively.
2022-07-19
- The
score
field inGET /{entity}/{external_id}/skill_profile
inlist
format is now optional.
2022-07-18
- Deprecated
GET /employees/{external_id}/recommended_courses
and added POST instead.
2022-06-03
- Removed
POST /competencies/{external_id}/similar
andPOST /competencies/{external_id}/profile/related
endpoints.
2022-05-23
- Removed
PUT /competencies/{external_id}/skill_profile
feedback endpoint.
2021-11-09
- Removed Document Entity and all its functionalities.
2021-07-28
- Similar Entity endpoints are now
POST
instead ofGET
. - The response format of Similar Entity endpoints has changed from a list to an object containing two fields: the list of results and the total number of results available.
2021-06-04
- Search endpoints now require weights in the body, in the same manner as matching endpoints.
- Search endpoints now support a
score_min_threshold
query parameter, and defaults to 0.5 for this value instead of the previously internal 0.0.
2021-04-30
- The language query parameter has become required for the creation and update of an entity.
2021-03-19
- The response format of matching results
(
GET/POST /employees/{external_id}/matching_vacancies
,GET/POST /vacancies/{external_id}/matching_employees
,GET /employees/{external_id}/matching_companies
andGET /companies/{external_id}/matching_employees
) has changed from a list to an object containing two fields: the list of results and the total number of results available. - The response format of search results (
POST /employees/search
,POST /vacancies/search
andPOST /companies/search
) has changed from a list to an object containing two fields: the list of search results and the total number of results available from the free text search. - The response format of list results (
GET /employees/
,GET /vacancies/
,GET /companies/
,GET /courses/
,GET /competencies/
,GET /documents/
andGET /occupations/
) has changed from a list to an object containing two fields: the list of results and the total number of results available.
2021-02-25
- Employee creation (
POST /employees
) and updates (PATCH /employees/{external_id}
) no longer support uploading individual resumes (asemployee_resume
) in favour of accepting a list of multiple resumes (asemployee_documents
) with the same format.
2021-02-03
- The list entity endpoints (
GET /employees
,GET /vacancies
,GET /courses
,GET /occupations
,GET /competencies
andGET /documents
) no longer support theresponse_format
query parameter. The response now corresponds to the formerobjects
response format for all endpoints.
2021-01-19
- The version endpoint now returns a body with a single field
version
, indicating the current version of your tenant. The version is returned as a date (ISO-8601, ex. 2021-01-19) and no longer as a number.
Was this page helpful?