WOworkable

/review-cycles/templates

Changed on

Returns the account's performance review master templates. Required scope: r_reviews. Requires a user token with permission to view performance templates, or an account token with the member_id of such a member; an account token without member_id gets 403.

Only the latest, non-deleted master templates in the performance_review category are returned. Pagination is optional via limit and offset; when omitted every template is returned.

get/review-cycles/templates

Request

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

Query parameters

limitinteger

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

offsetinteger

Number of templates 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

Example response

{
  "total_count": 1,
  "templates": [
    {
      "id": "template-spi-review-1",
      "title": "SPI Review Q1",
      "version": 1
    }
  ]
}

Changes

  • 13ad2e8e2ee9Revision changes
    • info

      added the new optional query request parameter member_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status