WOworkable

/review-cycles/:reviewCycleId/employees/:employeeId

Changed on

Returns an employee's review task (aggregate) in a cycle, including every review the caller may see, each with its questionnaire and saved answers. Required scope: r_reviews. Requires a user token, or an account token with member_id (the request is then evaluated with that member's permissions); an account token without member_id gets 403. The caller must be able to view review cycles: either the View review cycles permission (global or scoped), or View employee directory in an account with performance reviews enabled.

The caller must participate in the employee's review (reviewee, manager, someone in the reporting line, reviewer, or scoped/global review admin); otherwise 404. Callers who are only peer or upward reviewers see just their own review.

get/review-cycles/{reviewCycleId}/employees/{employeeId}

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/review-cycles/{reviewCycleId}/employees/{employeeId}
  • Auth
    API key in header Authorization

Path parameters

reviewCycleIdstring required

Review cycle SPI key (hexadecimal)

employeeIdstring required

Employee SPI key of the reviewee

Query parameters

member_idstring

Required when using an account token: the member (SPI key, from GET /members) to act as. The request is evaluated with that member's permissions; without it the request gets 403. Ignored for user tokens.

Response

200

idstring

Review task (aggregate) SPI key

status'ready' | 'draft' | 'not_ready'

Form preparation status of the task

state'not_started' | 'in_progress' | 'shared' | 'signed'

Overall state of the task

Changes