TRANXACT.AI Help

Talent & Contingent Workforce · Orders & Postings

Job Orders

What a client is asking for. The pipeline against each one is counted here, so a requisition with nothing out against it is visible at a glance.

Type REST14 operationsBase path /api/ats/job-ordersPublished as /api/v1/job-orders

Download specification (OpenAPI 3.1) Screen: Job Orders

Overview

PackageTalent & Contingent Workforce
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 Talent & Contingent Workforce › Job Orders 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.
Tableats.job_orders · 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/ats/job-ordersList job orders

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",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "job_order_no": "JOB-000001",
      "title": "Example",
      "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "rate_card_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "hiring_contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employment_type": "text",
      "work_arrangement": "text",
      "work_city": "text",
      "work_country": "US"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_order_no": "JOB-000001",
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_card_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employment_type": "text",
  "work_arrangement": "text",
  "work_city": "text",
  "work_country": "US"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
location_iduuidNoOffice
titletextYesRole title
client_iduuidYesClient
msp_program_iduuidNoProgramme
rate_card_iduuidNoRate card — With a card attached, a submission outside its ceiling is refused before the CV leaves the building.
hiring_contact_iduuidNoHiring contact
requisition_iduuidNoInternal requisition — Where the post being filled is our own. Links the two pipelines so filling one closes the other.
employment_typetextNoEngagement type
work_arrangementtextNoWork arrangement
work_citytextNoWork city
work_countrytextNoWork country
openingsintegerNoOpenings
prioritytextNoPriority
Allowed: low normal high critical
statustextNoStatus
opened_atdateNoOpened
target_start_datedateNoTarget start
target_end_datedateNoTarget end
duration_weeksintegerNoDuration (weeks)
submission_deadlinedateNoSubmission deadline
max_submissionsintegerNoSubmission limit
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_rate_minnumericNoBill rate from
bill_rate_maxnumericNoBill rate ceiling
pay_rate_maxnumericNoPay rate ceiling
salary_minnumericNoSalary from — Direct hire only.
salary_maxnumericNoSalary to
fee_pctnumericNoPlacement fee %
markup_pctnumericNoTarget markup %
hours_per_weeknumericNoHours a week
experience_years_minnumericNoMinimum experience (years)
education_leveltextNoEducation
clearance_requiredtextNoClearance required
descriptiontextNoDescription
screening_notestextNoScreening notes
internal_notestextNoInternal notes
recruiter_iduuidNoRecruiter
account_manager_iduuidNoAccount manager
cost_center_iduuidNoCost center
source_systemtextNoCame from
external_reftextNoReference over there
vms_req_idtextNoVMS requisition id

Sample body

{
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_card_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_order_no": "JOB-000001",
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_card_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employment_type": "text",
  "work_arrangement": "text",
  "work_city": "text",
  "work_country": "US"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/job-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","msp_program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","rate_card_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","hiring_contact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/ats/job-orders/{id}Change a job orders

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
location_iduuidNoOffice
titletextYesRole title
client_iduuidYesClient
msp_program_iduuidNoProgramme
rate_card_iduuidNoRate card — With a card attached, a submission outside its ceiling is refused before the CV leaves the building.
hiring_contact_iduuidNoHiring contact
requisition_iduuidNoInternal requisition — Where the post being filled is our own. Links the two pipelines so filling one closes the other.
employment_typetextNoEngagement type
work_arrangementtextNoWork arrangement
work_citytextNoWork city
work_countrytextNoWork country
openingsintegerNoOpenings
prioritytextNoPriority
Allowed: low normal high critical
statustextNoStatus
opened_atdateNoOpened
target_start_datedateNoTarget start
target_end_datedateNoTarget end
duration_weeksintegerNoDuration (weeks)
submission_deadlinedateNoSubmission deadline
max_submissionsintegerNoSubmission limit
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_rate_minnumericNoBill rate from
bill_rate_maxnumericNoBill rate ceiling
pay_rate_maxnumericNoPay rate ceiling
salary_minnumericNoSalary from — Direct hire only.
salary_maxnumericNoSalary to
fee_pctnumericNoPlacement fee %
markup_pctnumericNoTarget markup %
hours_per_weeknumericNoHours a week
experience_years_minnumericNoMinimum experience (years)
education_leveltextNoEducation
clearance_requiredtextNoClearance required
descriptiontextNoDescription
screening_notestextNoScreening notes
internal_notestextNoInternal notes
recruiter_iduuidNoRecruiter
account_manager_iduuidNoAccount manager
cost_center_iduuidNoCost center
source_systemtextNoCame from
external_reftextNoReference over there
vms_req_idtextNoVMS requisition id

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_order_no": "JOB-000001",
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rate_card_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "hiring_contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employment_type": "text",
  "work_arrangement": "text",
  "work_city": "text",
  "work_country": "US"
}

Sample request

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

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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/job-orders/{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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/ats/job-orders/{parentId}/skillsSkills

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/skills" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/job-orders/{parentId}/skillsSkills

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/skills" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/ats/job-orders/{parentId}/skills/{lineId}Skills

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/skills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ats/job-orders/{parentId}/skills/{lineId}Skills

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/skills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/job-orders/{id}/summariseSummarise

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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/summarise" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/job-orders/{id}/previewPreview

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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/job-orders/{id}/matchesMatches

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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/matches" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/job-orders/from-requisition/{id}From requisition

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

clientId*, employmentType, recruiterId; employmentType one of contract|contract_to_hire|direct_hire|temp|sow|internship|payrolling

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/ats/job-orders/from-requisition/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"value","employmentType":"value","recruiterId;":"value"}'

Data model

Every field of a job orders, 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
location_iduuidread, writeOffice
job_order_notextread onlyJob order no
titletextread, writeRole title
client_iduuidread, writeClient
msp_program_iduuidread, writeProgramme
rate_card_iduuidread, writeRate card — With a card attached, a submission outside its ceiling is refused before the CV leaves the building.
hiring_contact_iduuidread, writeHiring contact
requisition_iduuidread, writeInternal requisition — Where the post being filled is our own. Links the two pipelines so filling one closes the other.
employment_typetextread, writeEngagement type
work_arrangementtextread, writeWork arrangement
work_citytextread, writeWork city
work_countrytextread, writeWork country
openingsintegerread, writeOpenings
filled_countintegerread onlyFilled count
prioritytextread, writePriority
Allowed: low normal high critical
statustextread, writeStatus
opened_atdateread, writeOpened
closed_atdateread onlyClosed at
target_start_datedateread, writeTarget start
target_end_datedateread, writeTarget end
duration_weeksintegerread, writeDuration (weeks)
submission_deadlinedateread, writeSubmission deadline
max_submissionsintegerread, writeSubmission limit
currencytextread, writeCurrency
rate_unittextread, writeRate unit
Allowed: hour day week month year fixed
bill_rate_minnumericread, writeBill rate from
bill_rate_maxnumericread, writeBill rate ceiling
pay_rate_maxnumericread, writePay rate ceiling
salary_minnumericread, writeSalary from — Direct hire only.
salary_maxnumericread, writeSalary to
fee_pctnumericread, writePlacement fee %
markup_pctnumericread, writeTarget markup %
hours_per_weeknumericread, writeHours a week
experience_years_minnumericread, writeMinimum experience (years)
education_leveltextread, writeEducation
clearance_requiredtextread, writeClearance required
descriptiontextread, writeDescription
screening_notestextread, writeScreening notes
internal_notestextread, writeInternal notes
recruiter_iduuidread, writeRecruiter
account_manager_iduuidread, writeAccount manager
cost_center_iduuidread, writeCost center
source_systemtextread, writeCame from
external_reftextread, writeReference over there
vms_req_idtextread, writeVMS requisition id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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

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 Talent & Contingent Workforce › Job Orders 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.