TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Applications

Every application received against a vacancy, and what stage it has reached. This is the screen that answers "how many applied, how many were shortlisted, how many were interviewed, and who was selected" — counted from the record rather than from a spreadsheet somebody keeps.

Type REST11 operationsBase path /api/hrms/applicationsPublished as /api/v1/applications

Download specification (OpenAPI 3.1) Screen: Applications

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 › Applications 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.candidate_pipeline · 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

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

GET/api/hrms/applicationsList applications

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",
      "application_no": "APP-000001",
      "applied_on": "2026-10-30",
      "status": "draft",
      "rating": 10,
      "rejected_reason": "text",
      "candidate_no": "CAN-000001",
      "candidate_name": "Example",
      "email": "someone@example.com",
      "is_internal": true,
      "source": "text",
      "current_employer": "text",
      "current_title": "Example"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "application_no": "APP-000001",
  "applied_on": "2026-10-30",
  "status": "draft",
  "rating": 10,
  "rejected_reason": "text",
  "candidate_no": "CAN-000001",
  "candidate_name": "Example",
  "email": "someone@example.com",
  "is_internal": true,
  "source": "text",
  "current_employer": "text",
  "current_title": "Example"
}

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

Sample request

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

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/applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/self-identification" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/applications/{id}/self-identificationSelf identification

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/applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/self-identification" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/applications/{id}/self-identification-linkSelf identification link

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/applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/self-identification-link" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/applicationsPost applications

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/applications" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/applications/{id}/advanceAdvance

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

stageCode

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/applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/advance" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"stageCode":"value"}'
POST/api/hrms/applications/{id}/rejectReject

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

reason*

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/applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reject" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/hrms/applications/{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/applications/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/applications/{id}Put applications

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

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

Data model

Every field of a applications, 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
application_notextread onlyApplication no
applied_ondateread onlyApplied on
statustextread onlyStatus
ratingintegerread onlyRating
rejected_reasontextread onlyRejected reason
candidate_notextread onlyCandidate no
candidate_nametextread onlyCandidate name
emailtextread onlyEmail
is_internalbooleanread onlyIs internal
sourcetextread onlySource
current_employertextread onlyCurrent employer
current_titletextread onlyCurrent title
requisition_notextread onlyRequisition no
roletextread onlyRole
departmenttextread onlyDepartment
stage_codetextread onlyStage code
stagetextread onlyStage
stage_orderintegerread onlyStage order
is_terminalbooleanread onlyIs terminal
days_since_appliedintegerread onlyDays since applied
interviewsintegerread onlyInterviews
interviews_doneintegerread onlyInterviews done
average_scorenumericread onlyAverage score
offer_notextread onlyOffer no
offer_statustextread onlyOffer status

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 › Applications 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.