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.
/api/ats/job-ordersPublished as /api/v1/job-ordersOverview
| Package | Talent & Contingent Workforce |
|---|---|
| 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 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. |
| Table | ats.job_orders · 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/ats/job-ordersList job orders
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",
"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Office |
title | text | Yes | Role title |
client_id | uuid | Yes | Client |
msp_program_id | uuid | No | Programme |
rate_card_id | uuid | No | Rate card — With a card attached, a submission outside its ceiling is refused before the CV leaves the building. |
hiring_contact_id | uuid | No | Hiring contact |
requisition_id | uuid | No | Internal requisition — Where the post being filled is our own. Links the two pipelines so filling one closes the other. |
employment_type | text | No | Engagement type |
work_arrangement | text | No | Work arrangement |
work_city | text | No | Work city |
work_country | text | No | Work country |
openings | integer | No | Openings |
priority | text | No | Priority Allowed: low normal high critical |
status | text | No | Status |
opened_at | date | No | Opened |
target_start_date | date | No | Target start |
target_end_date | date | No | Target end |
duration_weeks | integer | No | Duration (weeks) |
submission_deadline | date | No | Submission deadline |
max_submissions | integer | No | Submission limit |
currency | text | No | Currency |
rate_unit | text | No | Rate unit Allowed: hour day week month year fixed |
bill_rate_min | numeric | No | Bill rate from |
bill_rate_max | numeric | No | Bill rate ceiling |
pay_rate_max | numeric | No | Pay rate ceiling |
salary_min | numeric | No | Salary from — Direct hire only. |
salary_max | numeric | No | Salary to |
fee_pct | numeric | No | Placement fee % |
markup_pct | numeric | No | Target markup % |
hours_per_week | numeric | No | Hours a week |
experience_years_min | numeric | No | Minimum experience (years) |
education_level | text | No | Education |
clearance_required | text | No | Clearance required |
description | text | No | Description |
screening_notes | text | No | Screening notes |
internal_notes | text | No | Internal notes |
recruiter_id | uuid | No | Recruiter |
account_manager_id | uuid | No | Account manager |
cost_center_id | uuid | No | Cost center |
source_system | text | No | Came from |
external_ref | text | No | Reference over there |
vms_req_id | text | No | VMS 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
| 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 |
|---|---|---|---|
location_id | uuid | No | Office |
title | text | Yes | Role title |
client_id | uuid | Yes | Client |
msp_program_id | uuid | No | Programme |
rate_card_id | uuid | No | Rate card — With a card attached, a submission outside its ceiling is refused before the CV leaves the building. |
hiring_contact_id | uuid | No | Hiring contact |
requisition_id | uuid | No | Internal requisition — Where the post being filled is our own. Links the two pipelines so filling one closes the other. |
employment_type | text | No | Engagement type |
work_arrangement | text | No | Work arrangement |
work_city | text | No | Work city |
work_country | text | No | Work country |
openings | integer | No | Openings |
priority | text | No | Priority Allowed: low normal high critical |
status | text | No | Status |
opened_at | date | No | Opened |
target_start_date | date | No | Target start |
target_end_date | date | No | Target end |
duration_weeks | integer | No | Duration (weeks) |
submission_deadline | date | No | Submission deadline |
max_submissions | integer | No | Submission limit |
currency | text | No | Currency |
rate_unit | text | No | Rate unit Allowed: hour day week month year fixed |
bill_rate_min | numeric | No | Bill rate from |
bill_rate_max | numeric | No | Bill rate ceiling |
pay_rate_max | numeric | No | Pay rate ceiling |
salary_min | numeric | No | Salary from — Direct hire only. |
salary_max | numeric | No | Salary to |
fee_pct | numeric | No | Placement fee % |
markup_pct | numeric | No | Target markup % |
hours_per_week | numeric | No | Hours a week |
experience_years_min | numeric | No | Minimum experience (years) |
education_level | text | No | Education |
clearance_required | text | No | Clearance required |
description | text | No | Description |
screening_notes | text | No | Screening notes |
internal_notes | text | No | Internal notes |
recruiter_id | uuid | No | Recruiter |
account_manager_id | uuid | No | Account manager |
cost_center_id | uuid | No | Cost center |
source_system | text | No | Came from |
external_ref | text | No | Reference over there |
vms_req_id | text | No | VMS 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
| 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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/job-orders/{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/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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| 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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/summarise" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/job-orders/{id}/previewPreview
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/ats/job-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/job-orders/{id}/matchesMatches
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/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
| 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):
clientId*, employmentType, recruiterId; employmentType one of contract|contract_to_hire|direct_hire|temp|sow|internship|payrollingResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
location_id | uuid | read, write | Office |
job_order_no | text | read only | Job order no |
title | text | read, write | Role title |
client_id | uuid | read, write | Client |
msp_program_id | uuid | read, write | Programme |
rate_card_id | uuid | read, write | Rate card — With a card attached, a submission outside its ceiling is refused before the CV leaves the building. |
hiring_contact_id | uuid | read, write | Hiring contact |
requisition_id | uuid | read, write | Internal requisition — Where the post being filled is our own. Links the two pipelines so filling one closes the other. |
employment_type | text | read, write | Engagement type |
work_arrangement | text | read, write | Work arrangement |
work_city | text | read, write | Work city |
work_country | text | read, write | Work country |
openings | integer | read, write | Openings |
filled_count | integer | read only | Filled count |
priority | text | read, write | Priority Allowed: low normal high critical |
status | text | read, write | Status |
opened_at | date | read, write | Opened |
closed_at | date | read only | Closed at |
target_start_date | date | read, write | Target start |
target_end_date | date | read, write | Target end |
duration_weeks | integer | read, write | Duration (weeks) |
submission_deadline | date | read, write | Submission deadline |
max_submissions | integer | read, write | Submission limit |
currency | text | read, write | Currency |
rate_unit | text | read, write | Rate unit Allowed: hour day week month year fixed |
bill_rate_min | numeric | read, write | Bill rate from |
bill_rate_max | numeric | read, write | Bill rate ceiling |
pay_rate_max | numeric | read, write | Pay rate ceiling |
salary_min | numeric | read, write | Salary from — Direct hire only. |
salary_max | numeric | read, write | Salary to |
fee_pct | numeric | read, write | Placement fee % |
markup_pct | numeric | read, write | Target markup % |
hours_per_week | numeric | read, write | Hours a week |
experience_years_min | numeric | read, write | Minimum experience (years) |
education_level | text | read, write | Education |
clearance_required | text | read, write | Clearance required |
description | text | read, write | Description |
screening_notes | text | read, write | Screening notes |
internal_notes | text | read, write | Internal notes |
recruiter_id | uuid | read, write | Recruiter |
account_manager_id | uuid | read, write | Account manager |
cost_center_id | uuid | read, write | Cost center |
source_system | text | read, write | Came from |
external_ref | text | read, write | Reference over there |
vms_req_id | text | read, write | VMS requisition id |
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 Talent & Contingent Workforce › Job Orders 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.