Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Performance > ReviewProcessCustomTemplate

Reads a single Review process custom template

Retrieves the templates for the company.

get/api/2026-07-01/resources/performance/review_process_custom_templates/{id}

Path parameters

idstring required

Filter by template IDs

Response

OK

idstring required

Review process template ID

author_idstring

Author of the custom template.

company_idstring required

Company ID

namestring required

Review process name

descriptionstring

A brief description of the review process

template_descriptionstring

A brief description of the review process template

target_strategyobject

Condition that defines the employees that will be evaluated (participants). Calculated when the review process starts

reviewer_strategiesstring[]

Review types that will be assigned to the review process. It'll be used to create the evaluations when the process starts

agreements_enabledboolean

Action plans help track goal progress, and facilitate performance review discussions.

employee_potential_score_enabledboolean

Include one question at the end of the review to rate participants' potential. This rating will be reflected in the 9 box grid.

competencies_assessments_enabledboolean

Assess employees based on their assigned competencies through both manager and self-reviews. Ensure roles with designated competencies are properly set up.

visibility_settingsobject

Visibility settings for the custom template

created_atstring required

Creation date of the template

Example response

{
  "id": "1",
  "author_id": "1",
  "company_id": "1",
  "name": "Performance Review - Q1 2024",
  "description": "Quarterly 360 review process",
  "template_description": "This template evaluates the performance of employees",
  "target_strategy": {
    "arguments": [],
    "strategy": "all_employees"
  },
  "reviewer_strategies": [
    "self",
    "manager"
  ],
  "agreements_enabled": true,
  "employee_potential_score_enabled": true,
  "visibility_settings": {
    "early_access_to_answers_for_managers": true,
    "restrict_answers_visibility_to_reportees": false,
    "anonymous_peer_evaluation_for_target": false
  },
  "created_at": "2025-01-01T00:00:00.000Z"
}