Skills
The library and who holds what. A level is an index into the skill type's levels, so the scale can be reworded without touching anyone's record. Levels are claims about people that HR reviews in the app — an employee's own proposal, a manager's entry, an appraisal — so an integration mirrors them rather than making them.
Available on plans that include skills management.
Plan feature
These endpoints need a plan that includes Skills management (skills). On a plan without it, requests return 402 with code: plan_upgrade_required and feature naming what an upgrade would add.
List skill types
GET
/v1/skill_typesQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
is_active | boolean | No | Filter by whether the record is in use. |
Responses
| Status | Meaning |
|---|---|
200 | A page of skill types. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Skills management (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve a skill type
GET
/v1/skill_types/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The skill type. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Skills management (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such skill type in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
List skills
GET
/v1/skillsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
is_active | boolean | No | Filter by whether the record is in use. |
skill_type_id | string | No | Only skills of this type. |
Responses
| Status | Meaning |
|---|---|
200 | A page of skills. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Skills management (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve a skill
GET
/v1/skills/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The skill. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Skills management (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such skill in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
List employee skills
GET
/v1/employee_skillsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
employee_id | string | No | Only the skills this employee holds. |
skill_id | string | No | Only who holds this skill. |
Responses
| Status | Meaning |
|---|---|
200 | A page of employee skills. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Skills management (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve an employee skill
GET
/v1/employee_skills/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The employee skill. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Skills management (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such employee skill in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |