WOworkable

/review-cycles

Changed on

Returns the performance review cycles visible to the caller. 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.

Archived and deleted cycles are never returned. Members without the View review cycles permission only see non-draft cycles they participate in (or that fall within their scoped role).

get/review-cycles

Request

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

Query parameters

statesstring[]

Filter by one or more cycle states (send as states[]=active&states[]=ended). Allowed: draft, scheduled, in_preparation, active, ended. Defaults to all of them.

limitinteger

Maximum number of cycles to return. When omitted, all matching cycles are returned.

offsetinteger

Number of cycles to skip (for pagination).

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

Number of review cycles matching the filters

Changes