HRMS · Performance & Talent
Talent Profiles
The nine-box as its two axes, plus flight risk, mobility and what the person themselves says they want — which is not the same as what has been planned for them.
/api/hrms/talent-profilesPublished as /api/v1/talent-profilesDownload specification (OpenAPI 3.1) Screen: Talent Profiles
Overview
| 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 › Talent Profiles 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.talent_profiles · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/talent-profilesList talent profiles
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",
"performance_rating": "text",
"potential_rating": "text",
"talent_segment": "high_potential",
"flight_risk": "low",
"retention_criticality": "low",
"career_aspiration": "text",
"mobility": "none",
"willing_to_relocate": true,
"ready_for_promotion": "now",
"development_plan": "text",
"mentor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"last_reviewed_on": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/talent-profiles?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/talent-profiles/{id}Read one talent profiles
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",
"performance_rating": "text",
"potential_rating": "text",
"talent_segment": "high_potential",
"flight_risk": "low",
"retention_criticality": "low",
"career_aspiration": "text",
"mobility": "none",
"willing_to_relocate": true,
"ready_for_promotion": "now",
"development_plan": "text",
"mentor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"last_reviewed_on": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/talent-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/talent-profilesCreate a talent profiles
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
employee_id | uuid | Yes | Employee |
performance_rating | text | No | Performance rating — The nine-box's across: outstanding or exceeds is high, meets is medium, partially or unsatisfactory is low. |
potential_rating | text | No | Potential rating — The nine-box's up: high, medium or low. |
talent_segment | text | No | Segment Allowed: high_potential key_talent solid_performer specialist new_to_role underperforming |
flight_risk | text | No | Flight risk Allowed: low moderate high imminent |
retention_criticality | text | No | Retention criticality Allowed: low moderate high critical |
career_aspiration | text | No | What they say they want |
mobility | text | No | Mobility Allowed: none local national international any |
willing_to_relocate | boolean | No | Willing to relocate |
ready_for_promotion | text | No | Ready for promotion Allowed: now 1_2_years 3_5_years not_now |
development_plan | text | No | Development plan |
mentor_id | uuid | No | Mentor |
last_reviewed_on | date | No | Last reviewed |
reviewed_by | uuid | No | Reviewed by |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performance_rating": "text",
"potential_rating": "text",
"talent_segment": "high_potential",
"flight_risk": "low"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performance_rating": "text",
"potential_rating": "text",
"talent_segment": "high_potential",
"flight_risk": "low",
"retention_criticality": "low",
"career_aspiration": "text",
"mobility": "none",
"willing_to_relocate": true,
"ready_for_promotion": "now",
"development_plan": "text",
"mentor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"last_reviewed_on": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/talent-profiles" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","performance_rating":"text","potential_rating":"text","talent_segment":"high_potential","flight_risk":"low"}'PUT/api/hrms/talent-profiles/{id}Change a talent profiles
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 | Yes | Employee |
performance_rating | text | No | Performance rating — The nine-box's across: outstanding or exceeds is high, meets is medium, partially or unsatisfactory is low. |
potential_rating | text | No | Potential rating — The nine-box's up: high, medium or low. |
talent_segment | text | No | Segment Allowed: high_potential key_talent solid_performer specialist new_to_role underperforming |
flight_risk | text | No | Flight risk Allowed: low moderate high imminent |
retention_criticality | text | No | Retention criticality Allowed: low moderate high critical |
career_aspiration | text | No | What they say they want |
mobility | text | No | Mobility Allowed: none local national international any |
willing_to_relocate | boolean | No | Willing to relocate |
ready_for_promotion | text | No | Ready for promotion Allowed: now 1_2_years 3_5_years not_now |
development_plan | text | No | Development plan |
mentor_id | uuid | No | Mentor |
last_reviewed_on | date | No | Last reviewed |
reviewed_by | uuid | No | Reviewed by |
effective_from | date | No | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | No | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
Sample body
{
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performance_rating": "text"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"performance_rating": "text",
"potential_rating": "text",
"talent_segment": "high_potential",
"flight_risk": "low",
"retention_criticality": "low",
"career_aspiration": "text",
"mobility": "none",
"willing_to_relocate": true,
"ready_for_promotion": "now",
"development_plan": "text",
"mentor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"last_reviewed_on": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/talent-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","performance_rating":"text"}'DELETE/api/hrms/talent-profiles/{id}Delete a talent profiles
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/talent-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/talent-profiles/{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/talent-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a talent profiles, 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 |
performance_rating | text | read, write | Performance rating — The nine-box's across: outstanding or exceeds is high, meets is medium, partially or unsatisfactory is low. |
potential_rating | text | read, write | Potential rating — The nine-box's up: high, medium or low. |
talent_segment | text | read, write | Segment Allowed: high_potential key_talent solid_performer specialist new_to_role underperforming |
flight_risk | text | read, write | Flight risk Allowed: low moderate high imminent |
retention_criticality | text | read, write | Retention criticality Allowed: low moderate high critical |
career_aspiration | text | read, write | What they say they want |
mobility | text | read, write | Mobility Allowed: none local national international any |
willing_to_relocate | boolean | read, write | Willing to relocate |
ready_for_promotion | text | read, write | Ready for promotion Allowed: now 1_2_years 3_5_years not_now |
development_plan | text | read, write | Development plan |
mentor_id | uuid | read, write | Mentor |
last_reviewed_on | date | read, write | Last reviewed |
reviewed_by | uuid | read, write | Reviewed by |
created_at | timestamp with time zone | read only | Created at |
effective_from | date | read, write | In force from — The date this version of the row takes effect. Leave it as today unless you are dating a change ahead. |
effective_to | date | read, write | Until — Leave empty for open-ended. Setting it ends this version rather than deleting it. |
org_unit_id | uuid | read only | Org unit id |
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 |
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 › Talent Profiles 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.