WOworkable

/review-cycles/templates/:id

Changed on

Returns a single performance review master template by its id. 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 template in the performance_review category is returned. Templates belonging to a different category (e.g. surveys) return 404.

get/review-cycles/templates/{id}

Request

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

Path parameters

idstring required

Master template id

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

Master template id

titlestring
updated_atstring nullable

ISO 8601 timestamp of the last update in the template registry

versioninteger
defaultboolean

Whether this is one of Workable's default templates

sampleboolean

Whether this is a sample template. Not returned by the create endpoint

disabledboolean

Whether the template is disabled

Example response

{
  "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