Skip to main content

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_types

Query parameters​

NameTypeRequiredDescription
limitintegerNoPage size. Values above 100 are clamped.
starting_afterstringNoOpaque cursor from a previous response’s next_cursor.
updated_sincetimestampNoReturn records changed at or after this instant. Tracks the record itself, not its child collections.
is_activebooleanNoFilter by whether the record is in use.

Responses​

StatusMeaning
200A page of skill types.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Skills management (plan_upgrade_required).
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve a skill type​

GET/v1/skill_types/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The skill type.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Skills management (plan_upgrade_required).
403The key does not carry the required scopes.
404No such skill type in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.

List skills​

GET/v1/skills

Query parameters​

NameTypeRequiredDescription
limitintegerNoPage size. Values above 100 are clamped.
starting_afterstringNoOpaque cursor from a previous response’s next_cursor.
updated_sincetimestampNoReturn records changed at or after this instant. Tracks the record itself, not its child collections.
is_activebooleanNoFilter by whether the record is in use.
skill_type_idstringNoOnly skills of this type.

Responses​

StatusMeaning
200A page of skills.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Skills management (plan_upgrade_required).
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve a skill​

GET/v1/skills/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The skill.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Skills management (plan_upgrade_required).
403The key does not carry the required scopes.
404No such skill in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.

List employee skills​

GET/v1/employee_skills

Query parameters​

NameTypeRequiredDescription
limitintegerNoPage size. Values above 100 are clamped.
starting_afterstringNoOpaque cursor from a previous response’s next_cursor.
updated_sincetimestampNoReturn records changed at or after this instant. Tracks the record itself, not its child collections.
employee_idstringNoOnly the skills this employee holds.
skill_idstringNoOnly who holds this skill.

Responses​

StatusMeaning
200A page of employee skills.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Skills management (plan_upgrade_required).
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve an employee skill​

GET/v1/employee_skills/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The employee skill.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Skills management (plan_upgrade_required).
403The key does not carry the required scopes.
404No such employee skill in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.