get
https://{subdomain}.workable.com/spi/v3/review-cycles/templates
Returns the account's performance review master templates. 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 templates in the performance_review category are returned. Survey templates are not included.
Pagination
limit and offset are optional. When both are omitted, every matching template is returned in a single response.
Results
{
"total_count": 1,
"templates": [
{
"id": "list-test-template-1",
"title": "List 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 |
|---|---|---|
| total_count | integer | Number of performance review templates in the account |
| templates | array | Array of template objects (see GET /review-cycles/templates/:id for the template payload) |
Error responses
| Status | Condition |
|---|---|
| 403 | Missing r_reviews scope, or the user lacks permission to view performance templates |
