v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Performance > Agreement

Reads a single Agreement

Retrieves the action plans of review processes.

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

Path parameters

idstring required

Filter by action plan IDs

Response

idstring required

Action plan ID

process_idstring required

Review process ID

target_idstring required

Review process target ID

signer_idstring

Manager access ID who signed the action plan

reviewer_idstring

Manager employee ID

manager_signed_atstring

Date when the manager signed the action plan

target_signed_atstring

Date when the employee signed the action plan

agreement_signed_atstring

Date when the action plan was last signed

last_modified_atstring

Date when the action plan was last modified

status'pending' | 'signed' required

Action plan status

lockedboolean required

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

conclusionsobject

Conclusions of the action plan

self_evaluation_idstring

Self review evaluation ID

manager_evaluation_idstring

Manager review evaluation ID

Example response

{
  "id": "1",
  "process_id": "1",
  "target_id": "1-3",
  "signer_id": "5",
  "reviewer_id": "3",
  "manager_signed_at": "2024-01-01T00:00:00Z",
  "target_signed_at": "2024-01-01T00:00:00Z",
  "agreement_signed_at": "2024-01-01T00:00:00Z",
  "last_modified_at": "2024-01-01T00:00:00Z",
  "status": "signed",
  "locked": true,
  "conclusions": {
    "text": "The employee is doing well.",
    "last_updated_at": "2024-01-01T00:00:00Z"
  },
  "self_evaluation_id": "1",
  "manager_evaluation_id": "2",
  "self_comments": [
    {
      "question_uuid": "z69c9b4d-0aa6-4ada-89d5-5fdcb04c1327",
      "author_access_id": 8,
      "text": "I am a team player.",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "manager_comments": [
    {
      "question_uuid": "a347a2fd-1a0a-4eee-b6c8-f74be63624fb",
      "author_access_id": 5,
      "text": "The employee is doing well.",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}