TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Hiring Requisitions

A request for a post: what it is, which grade, where, what it costs for a year, and why it is needed. Send it for signature and it collects the approvals its value calls for; only an approved vacancy can be advertised.

Type REST14 operationsBase path /api/hrms/requisitionsPublished as /api/v1/requisitions

Download specification (OpenAPI 3.1) Screen: Hiring Requisitions

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 Requisitions 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.requisitions · 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

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

GET/api/hrms/requisitionsList hiring requisitions

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",
      "requisition_no": "REQ-000001",
      "title": "Example",
      "position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "department": "text",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hiring_manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "recruiter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "openings": 10,
      "filled": 10,
      "reason": "growth"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_no": "REQ-000001",
  "title": "Example",
  "position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recruiter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "openings": 10,
  "filled": 10,
  "reason": "growth"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/requisitionsCreate a requisitions

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
titletextYesPost
position_iduuidNoPosition — The seat being filled. A vacancy against a position is what makes an establishment countable.
job_iduuidNoJob id
grade_iduuidNoGrade — Filled from the position when the position has a grade.
departmenttextNoDepartment
location_iduuidNoLocation — Where the post sits. It is also what the space and the ID card are arranged against when somebody accepts.
cost_center_iduuidNoCost center
hiring_manager_iduuidNoHiring manager — Left empty by a manager, it is the manager raising the requisition.
recruiter_iduuidNoRecruiter
openingsintegerNoNumber of posts
reasontextNoWhy the vacancy exists
Allowed: growth replacement backfill conversion seasonal project
employment_typetextNoEmployment type
Allowed: full_time part_time contract temporary intern
target_startdateNoWanted by
budget_minnumericNoPay range from
budget_maxnumericNoPay range to
descriptiontextNoWhat the post is
requirementstextNoWhat it requires
statustextNoStatus
justificationtextNoJustification — Why the post is needed. It is what the approvers actually read.
budget_annual_costnumericNoAnnual cost of the post — Salary plus everything that follows it, for one post for one year. Times the number of posts, it is what decides who has to sign, so a request without it cannot be sent for approval.

Sample body

{
  "title": "Example",
  "position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_no": "REQ-000001",
  "title": "Example",
  "position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recruiter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "openings": 10,
  "filled": 10,
  "reason": "growth"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/requisitions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","job_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","grade_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","department":"text"}'
PUT/api/hrms/requisitions/{id}Change a requisitions

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
titletextYesPost
position_iduuidNoPosition — The seat being filled. A vacancy against a position is what makes an establishment countable.
job_iduuidNoJob id
grade_iduuidNoGrade — Filled from the position when the position has a grade.
departmenttextNoDepartment
location_iduuidNoLocation — Where the post sits. It is also what the space and the ID card are arranged against when somebody accepts.
cost_center_iduuidNoCost center
hiring_manager_iduuidNoHiring manager — Left empty by a manager, it is the manager raising the requisition.
recruiter_iduuidNoRecruiter
openingsintegerNoNumber of posts
reasontextNoWhy the vacancy exists
Allowed: growth replacement backfill conversion seasonal project
employment_typetextNoEmployment type
Allowed: full_time part_time contract temporary intern
target_startdateNoWanted by
budget_minnumericNoPay range from
budget_maxnumericNoPay range to
descriptiontextNoWhat the post is
requirementstextNoWhat it requires
statustextNoStatus
justificationtextNoJustification — Why the post is needed. It is what the approvers actually read.
budget_annual_costnumericNoAnnual cost of the post — Salary plus everything that follows it, for one post for one year. Times the number of posts, it is what decides who has to sign, so a request without it cannot be sent for approval.

Sample body

{
  "title": "Example",
  "position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_no": "REQ-000001",
  "title": "Example",
  "position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recruiter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "openings": 10,
  "filled": 10,
  "reason": "growth"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/hrms/requisitions/{id}Delete a requisitions

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

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

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

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

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

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

channel, headline, body, closesOn, showPayRange; channel one of career_site|internal|job_board|agency|referral|social|university|other

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/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"channel":"value","headline":"value","body":"value","closesOn":"value","showPayRange;":"value"}'
GET/api/hrms/requisitions/seatsSeats

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/requisitions/seats" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/requisitions/hiring-managersHiring managers

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/requisitions/hiring-managers" \
  -H "Authorization: Bearer $TOKEN"
PATCH/api/hrms/requisitions/{id}Patch hiring requisitions

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 PATCH "https://demo.tranxact.ai/api/hrms/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/requisitions/{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/requisitions/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 requisitions, 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
requisition_notextread onlyRequisition no
titletextread, writePost
position_iduuidread, writePosition — The seat being filled. A vacancy against a position is what makes an establishment countable.
job_iduuidread, writeJob id
grade_iduuidread, writeGrade — Filled from the position when the position has a grade.
departmenttextread, writeDepartment
location_iduuidread, writeLocation — Where the post sits. It is also what the space and the ID card are arranged against when somebody accepts.
cost_center_iduuidread, writeCost center
hiring_manager_iduuidread, writeHiring manager — Left empty by a manager, it is the manager raising the requisition.
recruiter_iduuidread, writeRecruiter
openingsintegerread, writeNumber of posts
filledintegerread onlyFilled
reasontextread, writeWhy the vacancy exists
Allowed: growth replacement backfill conversion seasonal project
replacing_employee_iduuidread onlyReplacing employee id
employment_typetextread, writeEmployment type
Allowed: full_time part_time contract temporary intern
target_startdateread, writeWanted by
budget_minnumericread, writePay range from
budget_maxnumericread, writePay range to
currencytextread onlyCurrency
descriptiontextread, writeWhat the post is
requirementstextread, writeWhat it requires
statustextread, writeStatus
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
rejected_reasontextread onlyRejected reason
opened_ondateread onlyOpened on
closed_ondateread onlyClosed on
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
org_unit_iduuidread onlyOrg unit id
justificationtextread, writeJustification — Why the post is needed. It is what the approvers actually read.
budget_annual_costnumericread, writeAnnual cost of the post — Salary plus everything that follows it, for one post for one year. Times the number of posts, it is what decides who has to sign, so a request without it cannot be sent for approval.
approval_statustextread onlyApproval status
submitted_attimestamp with time zoneread onlySubmitted at
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
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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