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.
/api/hrms/requisitionsPublished as /api/v1/requisitionsDownload specification (OpenAPI 3.1) Screen: Hiring Requisitions
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 › 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. |
| Table | hr.requisitions · 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
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/requisitionsList hiring requisitions
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",
"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Post |
position_id | uuid | No | Position — The seat being filled. A vacancy against a position is what makes an establishment countable. |
job_id | uuid | No | Job id |
grade_id | uuid | No | Grade — Filled from the position when the position has a grade. |
department | text | No | Department |
location_id | uuid | No | Location — Where the post sits. It is also what the space and the ID card are arranged against when somebody accepts. |
cost_center_id | uuid | No | Cost center |
hiring_manager_id | uuid | No | Hiring manager — Left empty by a manager, it is the manager raising the requisition. |
recruiter_id | uuid | No | Recruiter |
openings | integer | No | Number of posts |
reason | text | No | Why the vacancy exists Allowed: growth replacement backfill conversion seasonal project |
employment_type | text | No | Employment type Allowed: full_time part_time contract temporary intern |
target_start | date | No | Wanted by |
budget_min | numeric | No | Pay range from |
budget_max | numeric | No | Pay range to |
description | text | No | What the post is |
requirements | text | No | What it requires |
status | text | No | Status |
justification | text | No | Justification — Why the post is needed. It is what the approvers actually read. |
budget_annual_cost | numeric | No | Annual 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
| 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 |
|---|---|---|---|
title | text | Yes | Post |
position_id | uuid | No | Position — The seat being filled. A vacancy against a position is what makes an establishment countable. |
job_id | uuid | No | Job id |
grade_id | uuid | No | Grade — Filled from the position when the position has a grade. |
department | text | No | Department |
location_id | uuid | No | Location — Where the post sits. It is also what the space and the ID card are arranged against when somebody accepts. |
cost_center_id | uuid | No | Cost center |
hiring_manager_id | uuid | No | Hiring manager — Left empty by a manager, it is the manager raising the requisition. |
recruiter_id | uuid | No | Recruiter |
openings | integer | No | Number of posts |
reason | text | No | Why the vacancy exists Allowed: growth replacement backfill conversion seasonal project |
employment_type | text | No | Employment type Allowed: full_time part_time contract temporary intern |
target_start | date | No | Wanted by |
budget_min | numeric | No | Pay range from |
budget_max | numeric | No | Pay range to |
description | text | No | What the post is |
requirements | text | No | What it requires |
status | text | No | Status |
justification | text | No | Justification — Why the post is needed. It is what the approvers actually read. |
budget_annual_cost | numeric | No | Annual 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
| 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/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/requisitions/{id}/panel-comparisonPanel comparison
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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
| 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):
channel, headline, body, closesOn, showPayRange; channel one of career_site|internal|job_board|agency|referral|social|university|otherResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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
| 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/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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
requisition_no | text | read only | Requisition no |
title | text | read, write | Post |
position_id | uuid | read, write | Position — The seat being filled. A vacancy against a position is what makes an establishment countable. |
job_id | uuid | read, write | Job id |
grade_id | uuid | read, write | Grade — Filled from the position when the position has a grade. |
department | text | read, write | Department |
location_id | uuid | read, write | Location — Where the post sits. It is also what the space and the ID card are arranged against when somebody accepts. |
cost_center_id | uuid | read, write | Cost center |
hiring_manager_id | uuid | read, write | Hiring manager — Left empty by a manager, it is the manager raising the requisition. |
recruiter_id | uuid | read, write | Recruiter |
openings | integer | read, write | Number of posts |
filled | integer | read only | Filled |
reason | text | read, write | Why the vacancy exists Allowed: growth replacement backfill conversion seasonal project |
replacing_employee_id | uuid | read only | Replacing employee id |
employment_type | text | read, write | Employment type Allowed: full_time part_time contract temporary intern |
target_start | date | read, write | Wanted by |
budget_min | numeric | read, write | Pay range from |
budget_max | numeric | read, write | Pay range to |
currency | text | read only | Currency |
description | text | read, write | What the post is |
requirements | text | read, write | What it requires |
status | text | read, write | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
rejected_reason | text | read only | Rejected reason |
opened_on | date | read only | Opened on |
closed_on | date | read only | Closed on |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
org_unit_id | uuid | read only | Org unit id |
justification | text | read, write | Justification — Why the post is needed. It is what the approvers actually read. |
budget_annual_cost | numeric | read, write | Annual 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_status | text | read only | Approval status |
submitted_at | timestamp with time zone | read only | Submitted at |
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 |
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 › Hiring Requisitions 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.