Initiates an Agreement

post https://api.factorialhr.com/api/2025-01-01/resources/performance/agreements/initiate

Initiate the action plan for a review process target ID in a review process.

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

string

required

Action plan ID

process_id

integer

required

Review process ID

target_id

string

required

Review process target ID

signer_id

integer

Manager access ID who signed the action plan

reviewer_id

integer

Manager employee ID

manager_signed_at

string

Date when the manager signed the action plan

target_signed_at

string

Date when the employee signed the action plan

agreement_signed_at

string

Date when the action plan was last signed

last_modified_at

string

Date when the action plan was last modified

status

string

required

Action plan status

pending signed

locked

boolean

required

When the action plan cannot be edited anymore. Locked when both manager and employee signed it.

conclusions

object

Conclusions of the action plan

Has additional fields

self_evaluation_id

integer

Self review evaluation ID

manager_evaluation_id

integer

Manager review evaluation ID

self_comments

array

required

Self comments by question

self_comments*

manager_comments

array

required

Manager comments by question

manager_comments*

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.factorialhr.com/api/2025-01-01/resources/performance/agreements/initiate \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200OK