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
Export Employee Skill Clusters data.
Export all Skill Clusters of all Employees by paginating through the data.
The Employees are returned based on their creation time, with those created first being returned first.
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/export/employees/skill_clusters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"limit": 10,
"starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
"filters": [
{
"filter": "is_active",
"is_active": true
}
],
"include": [
"sources",
"current_skills",
"related_skills",
"rejected_skills"
]
}'
{
"has_next": true,
"records": [
{
"external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
"skill_clusters": [
{
"skill_cluster_id": "51e605a8-ca08-4ba6-a359-28bad07b38f6",
"skill_cluster_name": "DevOps",
"domain_name": "Computer Science",
"proficiency_level": 3,
"validation_state": "validated",
"current_skills": [
{
"name": "Git",
"skill_id": "ed8a3b44-59a0-44a6-a283-6c0e4b303be1",
"validation_state": "suggested",
"skill_sources": [
"working_history",
"resume_document"
]
},
{
"name": "Jenkins",
"skill_id": "eebcf485-9045-4669-a6f7-6e7faa465ff9",
"validation_state": "suggested",
"skill_sources": [
"resume_document"
]
},
{
"name": "Kubernetes",
"skill_id": "94835c7e-4135-40d7-aea6-165b33d01589",
"validation_state": "validated",
"skill_sources": [
"working_history",
"resume_document"
]
}
],
"related_skills": [
{
"name": "Helm",
"skill_id": "63454703-6462-4ccc-bb50-34a0e99bfbf3",
"validation_state": "suggested",
"skill_sources": [
"resume_document",
"education_history"
]
}
],
"sources": [
"working_history",
"education_history",
"resume_document"
]
},
{
"skill_cluster_id": "df96accd-cfa9-414e-96e8-2f6421e9a768",
"skill_cluster_name": "Programming Languages",
"domain_name": "Computer Science",
"proficiency_level": 2,
"validation_state": "suggested",
"current_skills": [
{
"name": "Python",
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"validation_state": "suggested",
"skill_sources": [
"working_history"
]
},
{
"name": "Java",
"skill_id": "9e914d31-9db1-4d2d-8d16-ed8a88539879",
"validation_state": "rejected",
"skill_sources": [
"working_history"
]
}
],
"related_skills": [
{
"name": "Django",
"skill_id": "eeb27f67-8abc-4ad9-babb-7868eaa13078",
"validation_state": "suggested",
"skill_sources": [
"working_history"
]
},
{
"name": "Spring Framework",
"skill_id": "f21b6e1a-dee2-478a-b92f-b4641237af6b",
"validation_state": "suggested",
"skill_sources": [
"working_history"
]
}
],
"sources": [
"working_history"
]
}
]
},
{
"external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
"skill_clusters": [
{
"skill_cluster_id": "32575bc1-5c01-4d6f-89dc-8b4dceccf98a",
"skill_cluster_name": "Financial accounting",
"domain_name": "Finance",
"proficiency_level": 2,
"current_skills": [
{
"name": "Balance Sheet",
"skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
"validation_state": "validated",
"skill_sources": []
},
{
"name": "IFRS",
"skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
"validation_state": "suggested",
"skill_sources": [
"learning"
]
}
],
"related_skills": [],
"sources": [
"learning"
]
}
]
}
],
"next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002"
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
The number of Employees to show on a single page.
1 < x < 100
The external_id
of the Employee to continue looking from.
100
A set of filters to apply on the exported Employees.
Only include entities with the active
attribute set to true
or false
. If the filter is not set, all entities will be included.
is_active
Set to true
to only include entities with the active
attribute set to true
. Set to false
to only include entities with the active
attribute set to false
.
Expand the results with extra data.
current_skills
, related_skills
, rejected_skills
, sources
Response
True when there is more data after this page.
A list containing the requested data for each entity, limited by the limit
parameter.
The unique ID of the entity in your system, consisting of alphanumeric characters, hyphens and underscores.
List of Skill Clusters for the entity.
ID of the Skill Cluster.
Name of the Skill Cluster.
The name of the Domain associated with this Skill Cluster.
Proficiency level of the entity in this Skill Cluster.
0 < x < 3
This field indicates whether this Skill Cluster is already validated or rejected by a manager or Employee or still in the suggested state.
validated
, suggested
, rejected
The name of the Subdomain associated with this Skill Cluster. This field is only applicable in a 4-level Taxonomy.
The Skills of the Skill Cluster that are also in the Skills of the entity.
Name of the Skill.
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
This field indicates whether this Skill is already validated or rejected by a manager or Employee or still in the suggested state.
suggested
, validated
, rejected
The Skill Event types that led to the Skill.
The Skills of the Skill Cluster that are not in the Skills of the entity.
Name of the Skill.
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
This field indicates whether this Skill is already validated or rejected by a manager or Employee or still in the suggested state.
suggested
, rejected
The Skill Event types that led to the Skill.
The Skill Event types from which the Skills of the Skill Cluster were inferred.
The next starting_after
value for pagination.
100
Was this page helpful?
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/export/employees/skill_clusters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"limit": 10,
"starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
"filters": [
{
"filter": "is_active",
"is_active": true
}
],
"include": [
"sources",
"current_skills",
"related_skills",
"rejected_skills"
]
}'
{
"has_next": true,
"records": [
{
"external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
"skill_clusters": [
{
"skill_cluster_id": "51e605a8-ca08-4ba6-a359-28bad07b38f6",
"skill_cluster_name": "DevOps",
"domain_name": "Computer Science",
"proficiency_level": 3,
"validation_state": "validated",
"current_skills": [
{
"name": "Git",
"skill_id": "ed8a3b44-59a0-44a6-a283-6c0e4b303be1",
"validation_state": "suggested",
"skill_sources": [
"working_history",
"resume_document"
]
},
{
"name": "Jenkins",
"skill_id": "eebcf485-9045-4669-a6f7-6e7faa465ff9",
"validation_state": "suggested",
"skill_sources": [
"resume_document"
]
},
{
"name": "Kubernetes",
"skill_id": "94835c7e-4135-40d7-aea6-165b33d01589",
"validation_state": "validated",
"skill_sources": [
"working_history",
"resume_document"
]
}
],
"related_skills": [
{
"name": "Helm",
"skill_id": "63454703-6462-4ccc-bb50-34a0e99bfbf3",
"validation_state": "suggested",
"skill_sources": [
"resume_document",
"education_history"
]
}
],
"sources": [
"working_history",
"education_history",
"resume_document"
]
},
{
"skill_cluster_id": "df96accd-cfa9-414e-96e8-2f6421e9a768",
"skill_cluster_name": "Programming Languages",
"domain_name": "Computer Science",
"proficiency_level": 2,
"validation_state": "suggested",
"current_skills": [
{
"name": "Python",
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"validation_state": "suggested",
"skill_sources": [
"working_history"
]
},
{
"name": "Java",
"skill_id": "9e914d31-9db1-4d2d-8d16-ed8a88539879",
"validation_state": "rejected",
"skill_sources": [
"working_history"
]
}
],
"related_skills": [
{
"name": "Django",
"skill_id": "eeb27f67-8abc-4ad9-babb-7868eaa13078",
"validation_state": "suggested",
"skill_sources": [
"working_history"
]
},
{
"name": "Spring Framework",
"skill_id": "f21b6e1a-dee2-478a-b92f-b4641237af6b",
"validation_state": "suggested",
"skill_sources": [
"working_history"
]
}
],
"sources": [
"working_history"
]
}
]
},
{
"external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
"skill_clusters": [
{
"skill_cluster_id": "32575bc1-5c01-4d6f-89dc-8b4dceccf98a",
"skill_cluster_name": "Financial accounting",
"domain_name": "Finance",
"proficiency_level": 2,
"current_skills": [
{
"name": "Balance Sheet",
"skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
"validation_state": "validated",
"skill_sources": []
},
{
"name": "IFRS",
"skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
"validation_state": "suggested",
"skill_sources": [
"learning"
]
}
],
"related_skills": [],
"sources": [
"learning"
]
}
]
}
],
"next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002"
}