TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Hiring Approvals

Every signature a vacancy is waiting for, in the order they are collected. The level being waited on is the one whose earlier levels have all signed — nothing below it can be decided first.

Type REST7 operationsBase path /api/hrms/requisition-approvalsPublished as /api/v1/requisition-approvals

Download specification (OpenAPI 3.1) Screen: Hiring Approvals

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 › Hiring Approvals 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.requisition_approval_queue · 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

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

GET/api/hrms/requisition-approvalsList hiring approvals

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",
      "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "level_no": 10,
      "status": "draft",
      "approver_kind": "text",
      "approver_role": "text",
      "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "routed_by": "text",
      "amount": "1250.00",
      "currency": "USD",
      "requested_at": "2026-10-30T09:00:00Z",
      "due_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "level_no": 10,
  "status": "draft",
  "approver_kind": "text",
  "approver_role": "text",
  "approver_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approver_employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "routed_by": "text",
  "amount": "1250.00",
  "currency": "USD",
  "requested_at": "2026-10-30T09:00:00Z",
  "due_at": "2026-10-30T09:00:00Z"
}

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

Sample request

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

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):

decision, comment; decision one of approve|reject

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/requisition-approvals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"value","comment;":"value"}'
POST/api/hrms/requisition-approvalsPost hiring approvals

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/requisition-approvals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/requisition-approvals/{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/requisition-approvals/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/requisition-approvals/{id}Put hiring approvals

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/requisition-approvals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/requisition-approvals/{id}Delete hiring approvals

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/requisition-approvals/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a requisition approvals, 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
requisition_iduuidread onlyRequisition id
level_nointegerread onlyLevel no
statustextread onlyStatus
approver_kindtextread onlyApprover kind
approver_roletextread onlyApprover role
approver_user_iduuidread onlyApprover user id
approver_employee_iduuidread onlyApprover employee id
routed_bytextread onlyRouted by
amountnumericread onlyAmount
currencytextread onlyCurrency
requested_attimestamp with time zoneread onlyRequested at
due_attimestamp with time zoneread onlyDue at
decided_attimestamp with time zoneread onlyDecided at
decided_byuuidread onlyDecided by
commenttextread onlyComment
requisition_notextread onlyRequisition no
role_titletextread onlyRole title
departmenttextread onlyDepartment
openingsintegerread onlyOpenings
requisition_statustextread onlyRequisition status
approval_statustextread onlyApproval status
rule_codetextread onlyRule code
rule_nametextread onlyRule name
approver_nametextread onlyApprover name
approver_emailtextread onlyApprover email
decided_by_nametextread onlyDecided by name
raised_by_nametextread onlyRaised by name
overduebooleanread onlyOverdue
is_currentbooleanread onlyIs current

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 › Hiring Approvals 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.