Skip to main content

Performance

Goals and their alignment. A goal is set and checked in on by the people who own it, in the app; achievement is derived from current against target. Appraisals themselves are not a resource: the finalised review reaches you as the appraisal.finalized event, and 360° feedback as appraisal.feedback.*, never the answers.

Available on plans that include performance.

Plan feature

These endpoints need a plan that includes Performance & appraisals (performance). On a plan without it, requests return 402 with code: plan_upgrade_required and feature naming what an upgrade would add.

List goals​

GET/v1/goals

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 this employee’s goals.
department_idstringNoOnly this department’s goals.
parent_goal_idstringNoOnly goals aligned to this one.
statusactive · completed · cancelledNoOnly goals in this state.

Responses​

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

Retrieve a goal​

GET/v1/goals/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

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