/review-cycles/:reviewCycleId/answers

Changed on

Returns the individual question answers of the reviews in a cycle, paginated. 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.

Answers are scoped to what the caller can see: members with the global View review cycles permission see all answers; scoped admins see answers of employees in their scope plus their own and their reports'; everyone else sees only submitted reviews they can access as an employee (manager reviews of their own become visible once shared). Reviewers of anonymous reviews are redacted.

get/review-cycles/{reviewCycleId}/answers

Request

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

Path parameters

reviewCycleIdstring required

Review cycle SPI key (hexadecimal)

Query parameters

limitinteger

Maximum number of answers to return (1-200).

offsetinteger

Number of answers to skip.

question_idsstring[]

Filter by one or more question ids (UUIDs), e.g. question_ids[]=<uuid>.

review_typesstring[]

Filter by one or more review types, e.g. review_types[]=manager.

employee_idsstring[]

Filter by one or more reviewee employee SPI keys, e.g. employee_ids[]=4d4.

include_draftsboolean

Also include answers of reviews that are not yet submitted. Only effective for callers with the View review cycles permission (for scoped admins, only for employees within their scope).

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

total_countinteger

Total number of answers matching the filters

Changes