WOworkable

/review-cycles/:id

Changed on

Returns a single performance review cycle. 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, deleted and non-visible cycles return 404.

get/review-cycles/{id}

Request

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

Path parameters

idstring required

Review cycle SPI key (hexadecimal)

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 cycle SPI key

namestring

Name of the review cycle

descriptionstring nullable

Description of the review cycle

state'draft' | 'scheduled' | 'in_preparation' | 'active' | 'ended'

Review cycle state

start_datestring date-time

Date the cycle starts (ISO 8601)

end_datestring date-time

Date the cycle ends (ISO 8601)

review_period_startstring date-time

Start of the period under review (ISO 8601)

review_period_endstring date-time

End of the period under review (ISO 8601)

timezonestring nullable

Timezone of the cycle

employee_countinteger

Number of employees in the cycle

draft_countinteger

Number of reviews in draft

completed_countinteger

Number of completed reviews

not_started_countinteger

Number of reviews not yet started

share_start_datestring date-time nullable

Date from which reviews can be shared

share_deadlinestring date-time nullable

Deadline for sharing reviews

sign_deadlinestring date-time nullable

Deadline for signing reviews

employee_meeting_deadlinestring date-time nullable

Deadline for the review meeting

customization_start_datestring date-time nullable

Start of the form customization (preparation) window

customization_end_datestring date-time nullable

End of the form customization (preparation) window

has_manager_reviewboolean

Whether the cycle includes manager reviews

has_self_reviewboolean

Whether the cycle includes self reviews

has_peer_reviewsboolean

Whether the cycle includes peer reviews

has_upwards_reviewsboolean

Whether the cycle includes upward reviews

Changes