Reads a single Review process

get https://api.factorialhr.com/api/2025-04-01/resources/performance/review_processes/{id}

Response

Response body

object

integer

required

Review process ID

company_id

integer

required

Company ID

name

string

Review process name

description

string

A brief description of the review process

status

string

required

Review process status

draft scheduled active finished

target_strategy

object

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

Has additional fields

reviewer_strategies

array of strings

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

self manager direct_reports peers

reviewer_strategies

starts_at

string

Date when the review process should start

ends_at

string

Date when the review process should end

start_validation_errors

array of strings

required

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

missing_deadline invalid_deadline missing_title missing_target_strategy missing_target_strategy_members missing_reviewer_strategy missing_questions missing_potential_reviewers invalid_section_weights_sum

start_validation_errors*

archived

boolean

required

Whether the review process is archived or not

agreements_configuration

object

required

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

Has additional fields

employee_score_configuration

object

required

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

Has additional fields

competencies_assessments_configuration

object

required

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

Has additional fields

last_bulk_reminder

string

Date when the last bulk reminder was sent

cycle_id

string

Performance cycle ID

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.factorialhr.com/api/2025-04-01/resources/performance/review_processes/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK