HRMS · Recruiting & Onboarding
Recruiting Settings
Whether offers go out for electronic signature and who countersigns them, how long an applicant's self-identification link works, and the smallest group the EEO report will show.
/api/hrms/recruiting-settingsPublished as /api/v1/recruiting-settingsDownload specification (OpenAPI 3.1) Screen: Recruiting Settings
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 › Recruiting Settings 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.recruiting_settings · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key org_id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/recruiting-settingsList recruiting settings
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": [
{
"eeo_min_cell_size": 10,
"eeo_link_days": 10,
"offer_esign": true,
"offer_countersigner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"task_due_soon_days": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/recruiting-settings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/recruiting-settings/{org_id}Read one recruiting settings
Path parameters
| Name | Type | Description |
|---|---|---|
org_id | string (uuid) | The record's org_id, as a list returns it. |
Response 200
{
"eeo_min_cell_size": 10,
"eeo_link_days": 10,
"offer_esign": true,
"offer_countersigner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"task_due_soon_days": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/recruiting-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/recruiting-settingsCreate a recruiting settings
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
eeo_min_cell_size | integer | No | Smallest group the EEO report shows |
eeo_link_days | integer | No | Days a self-identification link works |
offer_esign | boolean | No | Send offers for electronic signature — Off: the letter is filed and emailed, and the acceptance is recorded by hand. |
offer_countersigner_id | uuid | No | Countersigns offers for the company — Where E-Signature requires the company to sign. Empty: whoever sends the offer. |
task_due_soon_days | integer | No | Days before due that a task shows as due soon |
Sample body
{
"eeo_min_cell_size": 10,
"eeo_link_days": 10,
"offer_esign": true,
"offer_countersigner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"eeo_min_cell_size": 10,
"eeo_link_days": 10,
"offer_esign": true,
"offer_countersigner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"task_due_soon_days": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/recruiting-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"eeo_min_cell_size":10,"eeo_link_days":10,"offer_esign":true,"offer_countersigner_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/recruiting-settings/{org_id}Change a recruiting settings
Path parameters
| Name | Type | Description |
|---|---|---|
org_id | string (uuid) | The record's org_id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
eeo_min_cell_size | integer | No | Smallest group the EEO report shows |
eeo_link_days | integer | No | Days a self-identification link works |
offer_esign | boolean | No | Send offers for electronic signature — Off: the letter is filed and emailed, and the acceptance is recorded by hand. |
offer_countersigner_id | uuid | No | Countersigns offers for the company — Where E-Signature requires the company to sign. Empty: whoever sends the offer. |
task_due_soon_days | integer | No | Days before due that a task shows as due soon |
Sample body
{
"eeo_min_cell_size": 10,
"eeo_link_days": 10
}Response 200
{
"eeo_min_cell_size": 10,
"eeo_link_days": 10,
"offer_esign": true,
"offer_countersigner_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"task_due_soon_days": 10,
"created_at": "2026-10-30T09:00:00Z",
"created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"updated_at": "2026-10-30T09:00:00Z",
"updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/recruiting-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"eeo_min_cell_size":10,"eeo_link_days":10}'DELETE/api/hrms/recruiting-settings/{org_id}Delete a recruiting settings
Path parameters
| Name | Type | Description |
|---|---|---|
org_id | string (uuid) | The record's org_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/recruiting-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/recruiting-settings/{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/recruiting-settings/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 recruiting settings, 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 |
|---|---|---|---|
org_id | uuid | read only | Org id |
eeo_min_cell_size | integer | read, write | Smallest group the EEO report shows |
eeo_link_days | integer | read, write | Days a self-identification link works |
offer_esign | boolean | read, write | Send offers for electronic signature — Off: the letter is filed and emailed, and the acceptance is recorded by hand. |
offer_countersigner_id | uuid | read, write | Countersigns offers for the company — Where E-Signature requires the company to sign. Empty: whoever sends the offer. |
task_due_soon_days | integer | read, write | Days before due that a task shows as due soon |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 › Recruiting Settings 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.