TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Job Postings

Where a vacancy was advertised, and for how long. One vacancy can be advertised on several channels at once — the staff portal and a newspaper are two postings against one request. Attach the published advertisement to the posting and it stays with the record of the appointment.

Type REST8 operationsBase path /api/hrms/job-postingsPublished as /api/v1/job-postings

Download specification (OpenAPI 3.1) Screen: Job Postings

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 › Job Postings 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.job_postings · 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

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

GET/api/hrms/job-postingsList job postings

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_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "channel": "career_site",
      "channel_name": "Example",
      "headline": "text",
      "body": "text",
      "show_pay_range": true,
      "posted_on": "2026-10-30",
      "closes_on": "2026-10-30",
      "external_url": "https://example.com",
      "external_ref": "text",
      "status": "draft",
      "views": 10,
      "applications": 10
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "channel": "career_site",
  "channel_name": "Example",
  "headline": "text",
  "body": "text",
  "show_pay_range": true,
  "posted_on": "2026-10-30",
  "closes_on": "2026-10-30",
  "external_url": "https://example.com",
  "external_ref": "text",
  "status": "draft",
  "views": 10,
  "applications": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
requisition_iduuidYesVacancy
channeltextNoChannel
Allowed: career_site internal job_board agency referral social university other
channel_nametextNoNamed where — The name of the newspaper, the board or the agency.
headlinetextYesHeadline
bodytextNoAdvertisement text
show_pay_rangebooleanNoShow the pay range
posted_ondateNoPosted on
closes_ondateNoCloses on
external_urltextNoLink to the advertisement
statustextNoStatus
Allowed: draft live paused closed expired

Sample body

{
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "headline": "text",
  "channel": "career_site",
  "channel_name": "Example",
  "body": "text",
  "show_pay_range": true
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "channel": "career_site",
  "channel_name": "Example",
  "headline": "text",
  "body": "text",
  "show_pay_range": true,
  "posted_on": "2026-10-30",
  "closes_on": "2026-10-30",
  "external_url": "https://example.com",
  "external_ref": "text",
  "status": "draft",
  "views": 10,
  "applications": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/job-postings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"requisition_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","headline":"text","channel":"career_site","channel_name":"Example","body":"text","show_pay_range":true}'
PUT/api/hrms/job-postings/{id}Change a job postings

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
requisition_iduuidYesVacancy
channeltextNoChannel
Allowed: career_site internal job_board agency referral social university other
channel_nametextNoNamed where — The name of the newspaper, the board or the agency.
headlinetextYesHeadline
bodytextNoAdvertisement text
show_pay_rangebooleanNoShow the pay range
posted_ondateNoPosted on
closes_ondateNoCloses on
external_urltextNoLink to the advertisement
statustextNoStatus
Allowed: draft live paused closed expired

Sample body

{
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "headline": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "channel": "career_site",
  "channel_name": "Example",
  "headline": "text",
  "body": "text",
  "show_pay_range": true,
  "posted_on": "2026-10-30",
  "closes_on": "2026-10-30",
  "external_url": "https://example.com",
  "external_ref": "text",
  "status": "draft",
  "views": 10,
  "applications": 10
}

Sample request

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

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

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

questions

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/job-postings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/screening-questions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"questions":"value"}'
PATCH/api/hrms/job-postings/{id}Patch job postings

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/job-postings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/job-postings/{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/job-postings/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 job postings, 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_iduuidread, writeVacancy
channeltextread, writeChannel
Allowed: career_site internal job_board agency referral social university other
channel_nametextread, writeNamed where — The name of the newspaper, the board or the agency.
headlinetextread, writeHeadline
bodytextread, writeAdvertisement text
show_pay_rangebooleanread, writeShow the pay range
posted_ondateread, writePosted on
closes_ondateread, writeCloses on
external_urltextread, writeLink to the advertisement
external_reftextread onlyExternal ref
statustextread, writeStatus
Allowed: draft live paused closed expired
viewsintegerread onlyViews
applicationsintegerread onlyApplications
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
screening_questionsjsonbread onlyScreening questions

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 › Job Postings 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.