v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Performance > ReviewProcess

Creates a Review process

Create a new review process.

post/api/2026-07-01/resources/performance/review_processes

Request body

author_access_idstring required

Access identifier of the author of the review process

namestring

Name of the review process

descriptionstring

A brief description of the review process

reviewer_strategiesstring[]

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

target_strategy'all_employees' | 'by_locations' | 'by_teams' | 'by_employees' | 'manual_selection'

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

argumentsstring[]

IDs of target strategy groups selected

ends_atstring

Date when the review process should end

agreements_enabledboolean

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

employee_score_enabledboolean

Include one question at the end of the review to rate participants' performance. This rating will be reflected on the results page.

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.

cycle_idstring

Performance cycle ID

Example request

{
  "author_access_id": "1",
  "name": "Performance Review - Q1 2024",
  "description": "The performance review for the first quarter of 2024 has started!",
  "reviewer_strategies": [
    "self",
    "manager"
  ],
  "target_strategy": "all_employees",
  "ends_at": "2024-04-01T00:00:00Z",
  "agreements_enabled": true,
  "employee_score_enabled": true,
  "employee_potential_score_enabled": true,
  "competencies_assessments_enabled": true,
  "cycle_id": "5"
}

Response

CREATED

idstring required

Review process ID

company_idstring required

Company ID

namestring

Review process name

descriptionstring

A brief description of the review process

status'draft' | 'scheduled' | 'starting' | 'active' | 'finished' required

Review process status

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

starts_atstring

Date when the review process should start

ends_atstring

Date when the review process should end

start_validation_errorsstring[] required

Missing or invalid information to be able to start the review process

archivedboolean required

Whether the review process is archived or not

agreements_configurationobject required

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

competencies_assessments_configurationobject required

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

last_bulk_reminderstring

Date when the last bulk reminder was sent

cycle_idstring

Performance cycle ID

Example response

{
  "id": "1",
  "company_id": "1",
  "name": "Performance Review - Q1 2024",
  "description": "The performance review for the first quarter of 2024 has started!",
  "status": "draft",
  "target_strategy": {
    "arguments": [],
    "strategy": "all_employees"
  },
  "reviewer_strategies": [
    "self",
    "manager"
  ],
  "starts_at": "2024-01-01T00:00:00.000Z",
  "ends_at": "2024-04-01T00:00:00.000Z",
  "start_validation_errors": [
    "invalid_deadline",
    "missing_target_strategy_members"
  ],
  "agreements_configuration": {
    "enabled": true
  },
  "competencies_assessments_configuration": {
    "enabled": false
  },
  "last_bulk_reminder": "2024-03-01T00:00:00.000Z",
  "cycle_id": "5"
}