TRANXACT.AI Help

Talent & Contingent Workforce · Pipeline

Submissions

One candidate against one job order, at one pair of rates. The margin is agreed here, and the placement is built from these numbers rather than from the job order’s.

Type REST12 operationsBase path /api/ats/submissionsPublished as /api/v1/submissions

Download specification (OpenAPI 3.1) Screen: Submissions

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 › Submissions 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.submissions · 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

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

GET/api/ats/submissionsList submissions

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",
      "submission_no": "SUB-000001",
      "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "stage": "text",
      "status": "active",
      "submitted_at": "2026-10-30T09:00:00Z",
      "submitted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "currency": "USD",
      "rate_unit": "hour",
      "bill_rate": "1250.00",
      "pay_rate": "1250.00",
      "salary": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "submission_no": "SUB-000001",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "stage": "text",
  "status": "active",
  "submitted_at": "2026-10-30T09:00:00Z",
  "submitted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "rate_unit": "hour",
  "bill_rate": "1250.00",
  "pay_rate": "1250.00",
  "salary": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
job_order_iduuidYesJob order
candidate_iduuidYesCandidate
stagetextNoStage
statustextNoOutcome
Allowed: active won lost withdrawn expired
submitted_attimestamp with time zoneNoSubmitted at
submitted_byuuidNoSubmitted by
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_ratenumericNoBill rate
pay_ratenumericNoPay rate
salarynumericNoSalary — Direct hire only — where there is no rate.
availability_datedateNoAvailable from
match_scorenumericNoMatch score
rankintegerNoRank
client_feedbacktextNoClient feedback
rejection_reasontextNoRejection reason
notestextNoNotes
vms_submission_idtextNoVMS submission id
external_reftextNoReference over there

Sample body

{
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "stage": "text",
  "status": "active",
  "submitted_at": "2026-10-30T09:00:00Z",
  "submitted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_no": "SUB-000001",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "stage": "text",
  "status": "active",
  "submitted_at": "2026-10-30T09:00:00Z",
  "submitted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "rate_unit": "hour",
  "bill_rate": "1250.00",
  "pay_rate": "1250.00",
  "salary": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/submissions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"job_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","candidate_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","stage":"text","status":"active","submitted_at":"2026-10-30T09:00:00Z","submitted_by":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/ats/submissions/{id}Change a submissions

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
job_order_iduuidYesJob order
candidate_iduuidYesCandidate
stagetextNoStage
statustextNoOutcome
Allowed: active won lost withdrawn expired
submitted_attimestamp with time zoneNoSubmitted at
submitted_byuuidNoSubmitted by
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_ratenumericNoBill rate
pay_ratenumericNoPay rate
salarynumericNoSalary — Direct hire only — where there is no rate.
availability_datedateNoAvailable from
match_scorenumericNoMatch score
rankintegerNoRank
client_feedbacktextNoClient feedback
rejection_reasontextNoRejection reason
notestextNoNotes
vms_submission_idtextNoVMS submission id
external_reftextNoReference over there

Sample body

{
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_no": "SUB-000001",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "stage": "text",
  "status": "active",
  "submitted_at": "2026-10-30T09:00:00Z",
  "submitted_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "currency": "USD",
  "rate_unit": "hour",
  "bill_rate": "1250.00",
  "pay_rate": "1250.00",
  "salary": "1250.00"
}

Sample request

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

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/submissions/{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/submissions/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/submissions/{parentId}/eventsEvents

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/submissions/{parentId}/eventsEvents

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/ats/submissions/{parentId}/events/{lineId}Events

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ats/submissions/{parentId}/events/{lineId}Events

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/events/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/submissions/{id}/submitSubmit

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

billRate, payRate, vmsSubmissionId, notes

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"billRate":"value","payRate":"value","vmsSubmissionId":"value","notes":"value"}'
POST/api/ats/submissions/{id}/advanceAdvance

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

stage, reason; stage one of screening|internal_review|client_review|interview|offer|rejected|withdrawn|on_hold

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/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/advance" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"stage":"value","reason;":"value"}'

Data model

Every field of a submissions, 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
submission_notextread onlySubmission no
job_order_iduuidread, writeJob order
candidate_iduuidread, writeCandidate
stagetextread, writeStage
statustextread, writeOutcome
Allowed: active won lost withdrawn expired
submitted_attimestamp with time zoneread, writeSubmitted at
submitted_byuuidread, writeSubmitted by
currencytextread, writeCurrency
rate_unittextread, writeRate unit
Allowed: hour day week month year fixed
bill_ratenumericread, writeBill rate
pay_ratenumericread, writePay rate
salarynumericread, writeSalary — Direct hire only — where there is no rate.
margin_amountnumericread onlyMargin amount
margin_pctnumericread onlyMargin pct
availability_datedateread, writeAvailable from
match_scorenumericread, writeMatch score
rankintegerread, writeRank
client_feedbacktextread, writeClient feedback
rejection_reasontextread, writeRejection reason
notestextread, writeNotes
vms_submission_idtextread, writeVMS submission id
external_reftextread, writeReference over there
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 › Submissions 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.