HRMS · Performance & Talent
Goals
How a goal is judged has to be agreed before the period rather than argued after it, which is what the measure and target are for.
/api/hrms/performance-goalsPublished as /api/v1/performance-goalsOverview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Goals on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | hr.performance_goals · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/performance-goalsList goals
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"review_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_goal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"description": "text",
"goal_type": "performance",
"category": "text",
"weight_pct": "1250.00",
"measure": "text",
"target_value": "text",
"actual_value": "text",
"start_date": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/performance-goals?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/performance-goals/{id}Read one performance goals
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"review_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_goal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"description": "text",
"goal_type": "performance",
"category": "text",
"weight_pct": "1250.00",
"measure": "text",
"target_value": "text",
"actual_value": "text",
"start_date": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/performance-goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-goalsCreate a performance goals
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | No | Employee — Blank for a company or department goal. |
cycle_id | uuid | No | Cycle |
review_id | uuid | No | Review id |
parent_goal_id | uuid | No | Aligned to |
title | text | Yes | Goal |
description | text | No | Description |
goal_type | text | No | Type Allowed: performance development behavioral project okr |
category | text | No | Category |
weight_pct | numeric | No | Weight % |
measure | text | No | How it is measured |
target_value | text | No | Target |
actual_value | text | No | Actual |
start_date | date | No | Starts |
due_date | date | No | Due |
completed_on | date | No | Completed on |
progress_pct | numeric | No | Progress % |
status | text | No | Status Allowed: draft active on_track at_risk behind achieved partially_achieved not_achieved cancelled |
rating | text | No | Rating |
is_private | boolean | No | Private |
org_unit_id | uuid | No | Department |
goal_level | text | No | Level Allowed: individual team department company |
Sample body
{
"title": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"review_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_goal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"review_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_goal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"description": "text",
"goal_type": "performance",
"category": "text",
"weight_pct": "1250.00",
"measure": "text",
"target_value": "text",
"actual_value": "text",
"start_date": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-goals" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","review_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","parent_goal_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/performance-goals/{id}Change a performance goals
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | No | Employee — Blank for a company or department goal. |
cycle_id | uuid | No | Cycle |
review_id | uuid | No | Review id |
parent_goal_id | uuid | No | Aligned to |
title | text | Yes | Goal |
description | text | No | Description |
goal_type | text | No | Type Allowed: performance development behavioral project okr |
category | text | No | Category |
weight_pct | numeric | No | Weight % |
measure | text | No | How it is measured |
target_value | text | No | Target |
actual_value | text | No | Actual |
start_date | date | No | Starts |
due_date | date | No | Due |
completed_on | date | No | Completed on |
progress_pct | numeric | No | Progress % |
status | text | No | Status Allowed: draft active on_track at_risk behind achieved partially_achieved not_achieved cancelled |
rating | text | No | Rating |
is_private | boolean | No | Private |
org_unit_id | uuid | No | Department |
goal_level | text | No | Level Allowed: individual team department company |
Sample body
{
"title": "Example",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"review_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"parent_goal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"description": "text",
"goal_type": "performance",
"category": "text",
"weight_pct": "1250.00",
"measure": "text",
"target_value": "text",
"actual_value": "text",
"start_date": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/performance-goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/hrms/performance-goals/{id}Delete a performance goals
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/performance-goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-goals/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/hrms/performance-goals/{id}/check-inCheck in
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check-in" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/performance-goals/{id}/cascadeCascade
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
employee_ids, employee_id, org_unit_id, title, weight_pctResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/performance-goals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cascade" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_ids":"value","employee_id":"value","org_unit_id":"value","title":"value","weight_pct":"value"}'Data model
Every field of a performance goals, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
employee_id | uuid | read, write | Employee — Blank for a company or department goal. |
cycle_id | uuid | read, write | Cycle |
review_id | uuid | read, write | Review id |
parent_goal_id | uuid | read, write | Aligned to |
title | text | read, write | Goal |
description | text | read, write | Description |
goal_type | text | read, write | Type Allowed: performance development behavioral project okr |
category | text | read, write | Category |
weight_pct | numeric | read, write | Weight % |
measure | text | read, write | How it is measured |
target_value | text | read, write | Target |
actual_value | text | read, write | Actual |
start_date | date | read, write | Starts |
due_date | date | read, write | Due |
completed_on | date | read, write | Completed on |
progress_pct | numeric | read, write | Progress % |
status | text | read, write | Status Allowed: draft active on_track at_risk behind achieved partially_achieved not_achieved cancelled |
rating | text | read, write | Rating |
is_private | boolean | read, write | Private |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read, write | Department |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
goal_level | text | read, write | Level Allowed: individual team department company |
last_checkin_on | date | read only | Last checkin on |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Goals for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.