API Documentation
Taxonomy
- Domains
- Subdomains
- Skill Clusters
- Skills
- Taxonomy operations
Employees
- CRUD
- Skill Profile
- Metrics
- Search
- Skill Events
- Interactions
- Suggestions
Job Families
- CRUD
- Skill Profile
- Job Family Profile Data
Jobs
- CRUD
- Skill Profile
- Job Profile Data
- Metrics
Vacancies
- CRUD
- Skill Profile
- Metrics
- Search
Courses
- CRUD
- Skill Profile
- Metrics
Skill Clusters
- CRUD
- Skill Profile
- Metrics
External Companies
- CRUD
- Search
Skills
- Skill Search
- Skill Gaps
- Skill Lookup
Organisational Structure
- Organisational Units
Custom Properties
- Definitions
- Properties
Matchmaking
- Vacancy Matching
- Course Recommendations
- External Company Matching
- Job Matching
- Job Family Matching
- Match Feedback
Matching Configuration
Export
- Employees
- Job Architecture
- Courses
- Employees Assigned Position
- Taxonomy
- Organisational Structure
Reports
- General Reports
- Employee Reports
- Vacancy Reports
- Job Reports
- Data Maturity Scan
Version
- Version
Get Taxonomy export
Get an export of the entire Taxonomy.
curl --request GET \
--url https://{tenant_name}.{region}.techwolf.ai/taxonomy/export \
--header 'Authorization: Bearer <token>'
{
"domains": [
{
"external_id": "48329b6e-6770-4f95-88a1-79dcc38b1c08",
"domain_name": "Human Resources",
"skill_clusters": [
{
"external_id": "c8e866ac-c1e5-4386-8911-d17320c54db9",
"skill_cluster_name": "Recruiting",
"skill_cluster_description": "Recruiting is the process of attracting, screening, and selecting qualified people for a job. Recruiting requires the ability to identify and attract potential candidates to an organization.",
"skills": [
{
"external_id": null,
"skill_id": "8037b52e-841c-471c-9c16-ffb0e9c6c490",
"skill_name": "Screening Resumes",
"skill_description": "The Screening Resumes process involves reviewing Job applicants' resumes in order to identify those candidates who best match the qualifications and requirements of the open position. The Skill \"Screening Resumes\" requires one to be able to quickly and effectively screen resumes in order to identify qualified candidates for a position.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "aa0195dc-3784-4c20-9d3c-5a6373ffd179",
"skill_name": "Student Recruiting",
"skill_description": "Student Recruiting is the process of attracting and enrolling students for educational institutions. The Skill \"Student Recruiting\" requires the ability to identify and attract potential students to an organization.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "77a43cdb-51d6-44f0-8f0e-d155f0bd0088",
"skill_name": "Writing",
"skill_description": "",
"skill_vocab": "TechWolf"
}
]
}
]
},
{
"external_id": "9c022f76-a649-4d08-a52f-ec3f9ad8ba42",
"domain_name": "IT",
"skill_clusters": [
{
"external_id": "2e7c8774-3416-4033-b640-8a255f70df2c",
"skill_cluster_name": "Programming Languages",
"skill_cluster_description": "Knowledge of programming languages and their use in software development.",
"skills": [
{
"external_id": null,
"skill_id": "c8c4b3a1-2d55-4dde-a71c-d7129c675a77",
"skill_name": "SQL",
"skill_description": "SQL is a standard database query language.The Skill \\\"SQL\\\" requires the ability to write and execute SQL queries.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"skill_name": "Python",
"skill_description": "Python is a high-level programming language with an intuitive syntax and a versatile standard library. The Skill \"Python\" requires the ability to write code in the Python programming language.",
"skill_vocab": "TechWolf"
}
]
},
{
"external_id": "564aadce-b2c7-4c4e-a87a-63263963db21",
"skill_cluster_name": "Debug Software",
"skill_cluster_description": "Debugging is the process of finding and resolving defects or problems within a computer program that prevent correct operation of computer software or a system. Debugging requires the ability to identify and fix issues within a software system.",
"skills": [
{
"external_id": null,
"skill_id": "267d511f-26d4-4c84-b2ae-eae89627deba",
"skill_name": "Unit Testing",
"skill_description": "Unit Testing is a software testing method in which individual units of source code, sets of one or more computer program modules together with associated control data, usage procedures, and operating procedures, are tested to determine whether they are fit for use. The Skill \"Unit Testing\" requires the ability to create and run tests on individual components of a software system to ensure they are functioning correctly.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"skill_name": "Python",
"skill_description": "Python is a high-level programming language with an intuitive syntax and a versatile standard library. The Skill \"Python\" requires the ability to write code in the Python programming language.",
"skill_vocab": "TechWolf"
}
]
}
]
}
]
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Additional attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.
skill_description
, skill_cluster_description
The display language used for Skill names. Altering the vocabulary language does not change the Skill Profile; it solely changes the way it is displayed. If not specified, the default language (en_uk
) will be used. The en
language is an alias for en_uk
.
en
, en_uk
, en_us
, de
, fr
, nl
Response
Default structure for Domain.
A list of all Domains within the Taxonomy.
The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.
1 - 100
Name of the Domain.
1 - 255
A list of all Skill Clusters within the Domain.
The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.
1 - 100
Name of the Skill Cluster.
1 - 255
A list of all Skills within the Skill Cluster.
The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.
1 - 100
The universal unique ID of the Skill, consisting of alphanumeric characters, hyphens and underscores. The Skill name connected to this id can be identified by either using the Skill Search endpoint or in any response body that contains that Skill.
1 - 100
Name of the Skill.
1 - 255
This field indicates which vocabulary the skill is part of.
TechWolf
Description of the Skill. If a custom description is provided, it will be returned; otherwise, the default description from TechWolf is returned.
Description of the Skill Cluster.
curl --request GET \
--url https://{tenant_name}.{region}.techwolf.ai/taxonomy/export \
--header 'Authorization: Bearer <token>'
{
"domains": [
{
"external_id": "48329b6e-6770-4f95-88a1-79dcc38b1c08",
"domain_name": "Human Resources",
"skill_clusters": [
{
"external_id": "c8e866ac-c1e5-4386-8911-d17320c54db9",
"skill_cluster_name": "Recruiting",
"skill_cluster_description": "Recruiting is the process of attracting, screening, and selecting qualified people for a job. Recruiting requires the ability to identify and attract potential candidates to an organization.",
"skills": [
{
"external_id": null,
"skill_id": "8037b52e-841c-471c-9c16-ffb0e9c6c490",
"skill_name": "Screening Resumes",
"skill_description": "The Screening Resumes process involves reviewing Job applicants' resumes in order to identify those candidates who best match the qualifications and requirements of the open position. The Skill \"Screening Resumes\" requires one to be able to quickly and effectively screen resumes in order to identify qualified candidates for a position.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "aa0195dc-3784-4c20-9d3c-5a6373ffd179",
"skill_name": "Student Recruiting",
"skill_description": "Student Recruiting is the process of attracting and enrolling students for educational institutions. The Skill \"Student Recruiting\" requires the ability to identify and attract potential students to an organization.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "77a43cdb-51d6-44f0-8f0e-d155f0bd0088",
"skill_name": "Writing",
"skill_description": "",
"skill_vocab": "TechWolf"
}
]
}
]
},
{
"external_id": "9c022f76-a649-4d08-a52f-ec3f9ad8ba42",
"domain_name": "IT",
"skill_clusters": [
{
"external_id": "2e7c8774-3416-4033-b640-8a255f70df2c",
"skill_cluster_name": "Programming Languages",
"skill_cluster_description": "Knowledge of programming languages and their use in software development.",
"skills": [
{
"external_id": null,
"skill_id": "c8c4b3a1-2d55-4dde-a71c-d7129c675a77",
"skill_name": "SQL",
"skill_description": "SQL is a standard database query language.The Skill \\\"SQL\\\" requires the ability to write and execute SQL queries.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"skill_name": "Python",
"skill_description": "Python is a high-level programming language with an intuitive syntax and a versatile standard library. The Skill \"Python\" requires the ability to write code in the Python programming language.",
"skill_vocab": "TechWolf"
}
]
},
{
"external_id": "564aadce-b2c7-4c4e-a87a-63263963db21",
"skill_cluster_name": "Debug Software",
"skill_cluster_description": "Debugging is the process of finding and resolving defects or problems within a computer program that prevent correct operation of computer software or a system. Debugging requires the ability to identify and fix issues within a software system.",
"skills": [
{
"external_id": null,
"skill_id": "267d511f-26d4-4c84-b2ae-eae89627deba",
"skill_name": "Unit Testing",
"skill_description": "Unit Testing is a software testing method in which individual units of source code, sets of one or more computer program modules together with associated control data, usage procedures, and operating procedures, are tested to determine whether they are fit for use. The Skill \"Unit Testing\" requires the ability to create and run tests on individual components of a software system to ensure they are functioning correctly.",
"skill_vocab": "TechWolf"
},
{
"external_id": null,
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"skill_name": "Python",
"skill_description": "Python is a high-level programming language with an intuitive syntax and a versatile standard library. The Skill \"Python\" requires the ability to write code in the Python programming language.",
"skill_vocab": "TechWolf"
}
]
}
]
}
]
}