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/goalsQuery 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 this employee’s goals. |
department_id | string | No | Only this department’s goals. |
parent_goal_id | string | No | Only goals aligned to this one. |
status | active · completed · cancelled | No | Only goals in this state. |
Responses
| Status | Meaning |
|---|---|
200 | A page of goals. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Performance & appraisals (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve a goal
GET
/v1/goals/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The goal. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Performance & appraisals (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such goal in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |