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 Job Skill Clusters data.
Export all Skill Clusters for all Jobs by paginating through the data.
The Jobs are returned based on their creation time, with those created first being returned first.
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export/jobs/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": [
"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",
"skills": [
{
"skill_name": "Git",
"skill_id": "ed8a3b44-59a0-44a6-a283-6c0e4b303be1",
"skill_types": [
{
"skill_type": "Job-Specific",
"is_common": true
}
]
}
]
},
{
"skill_cluster_id": "df96accd-cfa9-414e-96e8-2f6421e9a768",
"skill_cluster_name": "Programming Languages",
"domain_name": "Computer Science",
"skills": [
{
"skill_name": "Python",
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"skill_types": [
{
"skill_type": "Family-Specific"
}
]
},
{
"skill_name": "Java",
"skill_id": "9e914d31-9db1-4d2d-8d16-ed8a88539879",
"skill_types": [
{
"skill_type": "Job-Specific",
"is_common": true
}
]
}
]
}
]
},
{
"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",
"skills": [
{
"skill_name": "Balance Sheet",
"skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
"skill_types": [
{
"skill_type": "Job-Specific"
}
]
},
{
"skill_name": "IFRS",
"skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
"skill_types": [
{
"skill_type": "Job-Specific",
"is_common": true
}
]
}
]
}
]
}
],
"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 Jobs to show on a single page.
1 < x < 100
The external_id
of the Job to continue looking from.
100
A set of filters to apply on the exported Jobs.
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.
skills
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 Job in your system, consisting of alphanumeric characters, hyphens and underscores.
List of Skill Clusters for the Job.
ID of the Skill Cluster.
Name of the Skill Cluster.
The name of the Domain associated with this Skill Cluster.
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 Job.
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.
A list of skill types.
This field indicates whether a Skill is a Job-Specific Skill or a Family-Specific Skill.
Family-Specific
, Job-Specific
This field indicates whether a Skill is common between all Jobs in a Job Family. The is_common
field only appears when skill_type
is Job-Specific and when it is true.
The next starting_after
value for pagination.
100
Was this page helpful?
curl --request POST \
--url https://{tenant_name}.{region}.techwolf.ai/job_architecture/export/jobs/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": [
"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",
"skills": [
{
"skill_name": "Git",
"skill_id": "ed8a3b44-59a0-44a6-a283-6c0e4b303be1",
"skill_types": [
{
"skill_type": "Job-Specific",
"is_common": true
}
]
}
]
},
{
"skill_cluster_id": "df96accd-cfa9-414e-96e8-2f6421e9a768",
"skill_cluster_name": "Programming Languages",
"domain_name": "Computer Science",
"skills": [
{
"skill_name": "Python",
"skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
"skill_types": [
{
"skill_type": "Family-Specific"
}
]
},
{
"skill_name": "Java",
"skill_id": "9e914d31-9db1-4d2d-8d16-ed8a88539879",
"skill_types": [
{
"skill_type": "Job-Specific",
"is_common": true
}
]
}
]
}
]
},
{
"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",
"skills": [
{
"skill_name": "Balance Sheet",
"skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
"skill_types": [
{
"skill_type": "Job-Specific"
}
]
},
{
"skill_name": "IFRS",
"skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
"skill_types": [
{
"skill_type": "Job-Specific",
"is_common": true
}
]
}
]
}
]
}
],
"next_starting_after": "61a6e076-d780-11ec-9d64-0242ac120002"
}