get
https://{subdomain}.workable.com/spi/v3/review-cycles/templates/
Returns a single performance review master template by id. Required scope: r_reviews.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This endpoint uses ther_reviewsscope, which must be enabled through the Integrations section found within the Settings menu.
Requires a user token whose member has permission to view performance templates.
Only the latest, non-deleted master template in the performance_review category is returned. Templates belonging to a different category (for example surveys) return 404.
Results
{
"id": "get-test-template-1",
"title": "Get Test Template",
"updated_at": "2021-01-01T00:00:00.000Z",
"version": 1,
"questionnaire": {
"sections": [
{
"id": "section1",
"body": "Section 1: General Questions",
"questions": [
{
"id": "question1",
"body": "A question about performance",
"type": "star_rated"
},
{
"id": "question2",
"body": "Overall rating",
"type": "star_rated",
"metadata": {
"mandatory": true,
"semantic_type": "overall_rating"
}
}
]
}
]
}
}| key | type | description |
|---|---|---|
| id | string | Master template id |
| title | string | Title of the template |
| updated_at | string | null | ISO 8601 timestamp of the last update in the template registry |
| version | integer | Template version |
| questionnaire | object | Template questionnaire |
| questionnaire.sections | array | Ordered list of sections |
| questionnaire.sections[].id | string | Section id |
| questionnaire.sections[].body | string | Section title / header text |
| questionnaire.sections[].questions | array | Ordered list of questions in the section |
| questionnaire.sections[].questions[].id | string | Question id |
| questionnaire.sections[].questions[].body | string | Question text |
| questionnaire.sections[].questions[].type | string | Question type in snake_case. One of: paragraph, paragraph_star_rated, paragraph_numeric_rated, paragraph_custom_rated, single_choice, multiple_choice, star_rated, numeric_rated, custom_rated |
| questionnaire.sections[].questions[].metadata | object | Optional metadata for the question |
| questionnaire.sections[].questions[].metadata.mandatory | boolean | Whether an answer is required |
| questionnaire.sections[].questions[].metadata.semantic_type | string | Semantic role of the question. One of: section_rating, overall_rating |
| questionnaire.sections[].questions[].metadata.rating_options | object | Map of rating value to label |
| questionnaire.sections[].questions[].metadata.answer_options | object | Map of choice key to label, wrapped under choices |
Error responses
| Status | Condition |
|---|---|
| 403 | Missing r_reviews scope, or the user lacks permission to view performance templates |
| 404 | No performance review template exists with the supplied id |