Returns the caller's own review tasks in a performance review cycle. Required scope: r_reviews.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint uses ther_reviewsscope, which must be enabled through the Integrations section found within the Settings menu.
Requires a user token, or an account token together with the member_id query parameter (the request is then evaluated as that member). An account token without member_id gets 403 Account tokens need a member_id for this operation.
The member must be able to view review cycles: either through the View review cycles permission (global or scoped role), or through View employee directory in an account with performance reviews enabled.
Tasks are always returned from the perspective of the member's own employee record: only tasks where the member is the reviewee, the reviewing manager, or an assigned reviewer are included, regardless of admin permissions. If the member has no linked employee record, both arrays are empty. Archived and deleted cycles return 404.
Tasks are split in two groups:
preparation_tasks: tasks where the member is the reviewing manager and the review forms still need to be prepared (the cycle isscheduled/in_preparation, or the forms are not yet marked ready). Each review links to its form viaupdate_form_url; read it with GET /review-cycles/:reviewCycleId/tasks/:id/forms/:reviewType, customize it with PUT, and finish preparation with PUT /review-cycles/:reviewCycleId/tasks/:id. Only review types the cycle allows the manager to customize are listed.active_tasks: every other task in which the member has something to do or see.reviewslists the reviews assigned to the member as reviewer that are still writable or already submitted, with aviewaction (GET /review-cycles/:reviewCycleId/reviews/:id) and, while editable, awriteaction (PUT). Task-levelactionsmay includeview(employee review),share(share) andsign(sign); the key is omitted when no action is available. Tasks with neither reviews nor actions are left out.
Within each group tasks are ordered by reviewee name, then manager name.
Results
{
"preparation_tasks": [
{
"id": "4d4",
"status": "not_ready",
"review_cycle": {
"id": "4d6",
"name": "Mid-year Review 2025",
"state": "in_preparation",
"customization_start_date": "2025-05-01T00:00:00.000Z",
"customization_end_date": "2025-05-15T00:00:00.000Z"
},
"reviewee": {
"id": "4d5",
"name": "Doe, Jane"
},
"reviews": [
{
"id": "4d5",
"type": "self",
"status": "draft",
"master_template_id": "2000",
"follower_template_id": null,
"update_form_url": "/spi/v3/review-cycles/4d6/tasks/4d4/forms/self"
},
{
"id": "4d6",
"type": "manager",
"status": "draft",
"master_template_id": "3001",
"follower_template_id": null,
"update_form_url": "/spi/v3/review-cycles/4d6/tasks/4d4/forms/manager"
}
]
}
],
"active_tasks": [
{
"id": "4d3",
"state": "in_progress",
"review_cycle": {
"id": "4d6",
"name": "Mid-year Review 2025",
"state": "in_preparation"
},
"reviewee": {
"id": "4d4",
"name": "Brown, Alex"
},
"reviews": [
{
"id": "4e5",
"type": "manager",
"state": "submitted",
"submit_deadline": "2025-06-20T00:00:00.000Z",
"share_deadline": "2025-06-25T00:00:00.000Z",
"actions": {
"view": {
"url": "/spi/v3/review-cycles/4d6/reviews/4e5"
}
}
}
],
"actions": {
"view": {
"url": "/spi/v3/review-cycles/4d6/employees/4d4"
},
"share": {
"url": "/spi/v3/review-cycles/4d6/tasks/4d3/share"
}
}
}
]
}| key | type | description |
|---|---|---|
| preparation_tasks | array | Tasks whose forms the member must prepare as reviewing manager |
| preparation_tasks[].id | string | Review task (aggregate) SPI key, used as :id in the form and task endpoints |
| preparation_tasks[].status | string | Form preparation status. One of: ready, draft, not_ready |
| preparation_tasks[].review_cycle | object | id, name, state, customization_start_date, customization_end_date |
| preparation_tasks[].reviewee | object | id (SPI key) and name of the employee being reviewed |
| preparation_tasks[].reviews | array | Customizable reviews of the task |
| preparation_tasks[].reviews[].id | string | Review SPI key |
| preparation_tasks[].reviews[].type | string | One of: self, manager, peer, upwards |
| preparation_tasks[].reviews[].status | string | ready or draft |
| preparation_tasks[].reviews[].master_template_id | string | null | Master template configured for this review type |
| preparation_tasks[].reviews[].follower_template_id | string | null | Customized template id, null until customized |
| preparation_tasks[].reviews[].update_form_url | string | Relative URL of the review's form endpoint |
| active_tasks | array | Tasks with reviews to write or view, or task-level actions |
| active_tasks[].id | string | Review task (aggregate) SPI key |
| active_tasks[].state | string | One of: not_started, in_progress, shared, signed |
| active_tasks[].review_cycle | object | id, name and state of the cycle |
| active_tasks[].reviewee | object | id (SPI key) and name of the employee being reviewed |
| active_tasks[].reviews | array | Reviews assigned to the member as reviewer |
| active_tasks[].reviews[].id | string | Review SPI key |
| active_tasks[].reviews[].type | string | One of: self, manager, peer, upwards |
| active_tasks[].reviews[].state | string | One of: not_started, draft, submitted |
| active_tasks[].reviews[].submit_deadline | string | null | ISO 8601 submission deadline |
| active_tasks[].reviews[].share_deadline | string | null | ISO 8601 share deadline |
| active_tasks[].reviews[].actions | object | view.url always; write.url while the review can still be edited |
| active_tasks[].actions | object | Optional. Any of view.url, share.url, sign.url |
Error responses
Error bodies come in three shapes. 400 validation errors are a JSON object keyed by the invalid parameter, e.g. {"limit": {"code": "number.max", "message": "\"limit\" must be less than or equal to 200"}}. 401 and 403 are plain-text bodies, e.g. Required scopes missing: ["r_reviews"], or Forbidden when the member lacks permission. 404 is JSON, e.g. {"message": "Review cycle not found"}.
| Status | Condition |
|---|---|
| 400 | reviewCycleId is not a valid SPI key |
| 401 | Missing or invalid token |
| 403 | Missing r_reviews scope, account token without member_id, or the member cannot view review cycles |
| 404 | The review cycle does not exist in the account or is archived or deleted |
