API Reference
API Reference

/review-cycles/templates

Returns the account's performance review master templates. Required scope: r_reviews.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

This endpoint uses the r_reviews scope, 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"
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
keytypedescription
total_countintegerNumber of performance review templates in the account
templatesarrayArray of template objects (see GET /review-cycles/templates/:id for the template payload)

Error responses

StatusCondition
403Missing r_reviews scope, or the user lacks permission to view performance templates
Query Params
integer
≥ 1

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

integer
≥ 0

Number of templates to skip (for pagination).

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json