TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/hrms/performance-goalsPublished as /api/v1/performance-goals

Download specification (OpenAPI 3.1) Screen: Goals

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablehr.performance_goals · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
employee_iduuidNoEmployee — Blank for a company or department goal.
cycle_iduuidNoCycle
review_iduuidNoReview id
parent_goal_iduuidNoAligned to
titletextYesGoal
descriptiontextNoDescription
goal_typetextNoType
Allowed: performance development behavioral project okr
categorytextNoCategory
weight_pctnumericNoWeight %
measuretextNoHow it is measured
target_valuetextNoTarget
actual_valuetextNoActual
start_datedateNoStarts
due_datedateNoDue
completed_ondateNoCompleted on
progress_pctnumericNoProgress %
statustextNoStatus
Allowed: draft active on_track at_risk behind achieved partially_achieved not_achieved cancelled
ratingtextNoRating
is_privatebooleanNoPrivate
org_unit_iduuidNoDepartment
goal_leveltextNoLevel
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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
employee_iduuidNoEmployee — Blank for a company or department goal.
cycle_iduuidNoCycle
review_iduuidNoReview id
parent_goal_iduuidNoAligned to
titletextYesGoal
descriptiontextNoDescription
goal_typetextNoType
Allowed: performance development behavioral project okr
categorytextNoCategory
weight_pctnumericNoWeight %
measuretextNoHow it is measured
target_valuetextNoTarget
actual_valuetextNoActual
start_datedateNoStarts
due_datedateNoDue
completed_ondateNoCompleted on
progress_pctnumericNoProgress %
statustextNoStatus
Allowed: draft active on_track at_risk behind achieved partially_achieved not_achieved cancelled
ratingtextNoRating
is_privatebooleanNoPrivate
org_unit_iduuidNoDepartment
goal_leveltextNoLevel
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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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_pct

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
employee_iduuidread, writeEmployee — Blank for a company or department goal.
cycle_iduuidread, writeCycle
review_iduuidread, writeReview id
parent_goal_iduuidread, writeAligned to
titletextread, writeGoal
descriptiontextread, writeDescription
goal_typetextread, writeType
Allowed: performance development behavioral project okr
categorytextread, writeCategory
weight_pctnumericread, writeWeight %
measuretextread, writeHow it is measured
target_valuetextread, writeTarget
actual_valuetextread, writeActual
start_datedateread, writeStarts
due_datedateread, writeDue
completed_ondateread, writeCompleted on
progress_pctnumericread, writeProgress %
statustextread, writeStatus
Allowed: draft active on_track at_risk behind achieved partially_achieved not_achieved cancelled
ratingtextread, writeRating
is_privatebooleanread, writePrivate
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread, writeDepartment
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
goal_leveltextread, writeLevel
Allowed: individual team department company
last_checkin_ondateread onlyLast checkin on

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Goals for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.