TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Joining & Leaving

Every checklist actually running: whose it is, what is done, what is overdue. A new joiner's access, card and desk are on one of these, and so is what a leaver still has to hand back.

Type REST9 operationsBase path /api/hrms/checklistsPublished as /api/v1/checklists

Download specification (OpenAPI 3.1) Screen: Joining & Leaving

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 › Joining & Leaving 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.checklist_progress · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/checklistsList joining & leaving

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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "checklist_no": "CHE-000001",
      "purpose": "text",
      "anchor_date": "2026-10-30",
      "status": "draft",
      "employee_no": "EMP-000001",
      "employee_name": "Example",
      "candidate_no": "CAN-000001",
      "candidate_name": "Example",
      "template": "text",
      "tasks": 10,
      "done": 10,
      "overdue": 10
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/checklists?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/checklists/{id}Read one checklists

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "checklist_no": "CHE-000001",
  "purpose": "text",
  "anchor_date": "2026-10-30",
  "status": "draft",
  "employee_no": "EMP-000001",
  "employee_name": "Example",
  "candidate_no": "CAN-000001",
  "candidate_name": "Example",
  "template": "text",
  "tasks": 10,
  "done": 10,
  "overdue": 10
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/checklists/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/checklists/{id}/tasksTasks

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/checklists/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/checklists/{id}/tasks/{taskId}/completeTasks complete

Path parameters

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

Request body

The keys this action reads (* = required; "one of" lists the only values):

signedByName, waive, notes

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/checklists/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"signedByName":"value","waive":"value","notes":"value"}'
POST/api/hrms/checklists/startStart

Request body

The keys this action reads (* = required; "one of" lists the only values):

employeeId*, purpose, anchorDate

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/checklists/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","purpose":"value","anchorDate":"value"}'
POST/api/hrms/checklistsPost joining & leaving

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/checklists" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/checklists/{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/checklists/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/checklists/{id}Put joining & leaving

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 PUT "https://demo.tranxact.ai/api/hrms/checklists/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/checklists/{id}Delete joining & leaving

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 DELETE "https://demo.tranxact.ai/api/hrms/checklists/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a checklists, 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
org_unit_iduuidread onlyOrg unit id
checklist_notextread onlyChecklist no
purposetextread onlyPurpose
anchor_datedateread onlyAnchor date
statustextread onlyStatus
employee_notextread onlyEmployee no
employee_nametextread onlyEmployee name
candidate_notextread onlyCandidate no
candidate_nametextread onlyCandidate name
templatetextread onlyTemplate
tasksintegerread onlyTasks
doneintegerread onlyDone
overdueintegerread onlyOverdue
blockingintegerread onlyBlocking
standingtextread onlyStanding

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 › Joining & Leaving 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.