Developer Reference
API Reference
REST API for custom HRIS connectors, skill gap queries, and reporting data export. Available on Enterprise plans. All requests require Bearer token authentication.
POST
/v1/skill-gaps
Query skill gaps for a team or the full organization. Supports filtering by skill, deadline, and severity.
Request body
{
"team_id": "eng-cloud-platform", // optional
"deadline": "2026-09-01", // ISO 8601, optional
"skills_filter": ["cloud-native"], // skill taxonomy IDs, optional
"severity": "critical" // critical | elevated | all
}
Response (200 OK)
{
"total_gaps": 47,
"gaps": [
{
"employee_id": "emp_4821",
"skill": "cloud-native-architecture",
"gap_severity": "critical",
"days_to_deadline": 89,
"current_level": 1, // 0-5 scale
"required_level": 3
}
],
"cursor": "eyJwYWdlIjoy..." // for pagination
}
GET
/v1/employees/{employee_id}/profile
Retrieve the skill profile for a specific employee, including current skill levels and active learning paths.
Response (200 OK)
{
"employee_id": "emp_4821",
"skills": [
{
"skill_id": "cloud-native-architecture",
"level": 1,
"last_assessed": "2026-04-15"
}
],
"active_paths": ["path_7721"],
"gaps_count": 3
}
POST
/v1/paths/generate
Trigger path generation for one or more employees based on specified skill gaps. Returns the generated path IDs.
Request body
{
"employee_ids": ["emp_4821", "emp_4822"],
"skill": "cloud-native-architecture",
"deadline": "2026-09-01",
"auto_enroll": true
}
GET
/v1/reports/gap-closure
Retrieve gap closure rate statistics over a specified time window. Used for board reporting exports.
Query parameters
# Query params
?period=90d # 30d | 60d | 90d | ytd
&group_by=department # department | role | skill
&format=json # json | csv
Rate Limits
| Tier | Requests/min | Requests/day |
|---|---|---|
| Enterprise | 120 | 50,000 |
| Growth | 30 | 10,000 |
Rate limit exceeded responses return HTTP 429. Retry-After header indicates when requests may resume.