Talent & Contingent Workforce · Advertising
Board Applications
What came back. Deliberately not a candidate: an application is what arrived, and a candidate is what somebody decided to keep. Most applications never become candidates.
/api/ats/board-applicationsPublished as /api/v1/board-applicationsDownload specification (OpenAPI 3.1) Screen: Board Applications
Overview
| 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 › Board Applications 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.board_applications · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ats/board-applicationsList board applications
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",
"posting_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"external_id": "text",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"location_text": "text",
"headline": "text",
"cover_letter": "text",
"resume_url": "https://example.com"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ats/board-applications?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/board-applications/{id}Read one application
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",
"posting_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"external_id": "text",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"location_text": "text",
"headline": "text",
"cover_letter": "text",
"resume_url": "https://example.com"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ats/board-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/board-applicationsCreate a application
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
posting_id | uuid | No | Posting it answers — The job order and the board are the posting’s when left empty. |
job_order_id | uuid | No | Job order |
board_code | text | No | Board |
external_id | text | No | The board’s own reference |
first_name | text | No | First name |
last_name | text | No | Last name |
email | text | No | |
phone | text | No | Phone |
location_text | text | No | Where they are |
headline | text | No | Headline |
cover_letter | text | No | Cover letter |
resume_url | text | No | Résumé link |
resume_text | text | No | Resume text |
profile_url | text | No | Profile link |
answers | jsonb | No | Answers |
status | text | No | Status |
rejected_reason | text | No | Rejected because |
applied_at | timestamp with time zone | No | Applied |
Sample body
{
"posting_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"external_id": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"posting_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"external_id": "text",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"location_text": "text",
"headline": "text",
"cover_letter": "text",
"resume_url": "https://example.com"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/board-applications" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"posting_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","job_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","board_code":"BOA-000001","external_id":"text"}'PUT/api/ats/board-applications/{id}Change a application
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 |
|---|---|---|---|
posting_id | uuid | No | Posting it answers — The job order and the board are the posting’s when left empty. |
job_order_id | uuid | No | Job order |
board_code | text | No | Board |
external_id | text | No | The board’s own reference |
first_name | text | No | First name |
last_name | text | No | Last name |
email | text | No | |
phone | text | No | Phone |
location_text | text | No | Where they are |
headline | text | No | Headline |
cover_letter | text | No | Cover letter |
resume_url | text | No | Résumé link |
resume_text | text | No | Resume text |
profile_url | text | No | Profile link |
answers | jsonb | No | Answers |
status | text | No | Status |
rejected_reason | text | No | Rejected because |
applied_at | timestamp with time zone | No | Applied |
Sample body
{
"posting_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"posting_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"external_id": "text",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"location_text": "text",
"headline": "text",
"cover_letter": "text",
"resume_url": "https://example.com"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/board-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"posting_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","job_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/ats/board-applications/{id}Delete a application
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/board-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/board-applications/{id}/resumeResume
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):
fileResponse
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/board-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resume" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"file":"value"}'POST/api/ats/board-applications/{id}/score-resumeScore resume
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/board-applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/score-resume" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/board-applications/{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/board-applications/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 application, 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 |
posting_id | uuid | read, write | Posting it answers — The job order and the board are the posting’s when left empty. |
job_order_id | uuid | read, write | Job order |
board_code | text | read, write | Board |
external_id | text | read, write | The board’s own reference |
first_name | text | read, write | First name |
last_name | text | read, write | Last name |
email | text | read, write | |
phone | text | read, write | Phone |
location_text | text | read, write | Where they are |
headline | text | read, write | Headline |
cover_letter | text | read, write | Cover letter |
resume_url | text | read, write | Résumé link |
resume_text | text | read, write | Resume text |
document_id | uuid | read only | Document id |
profile_url | text | read, write | Profile link |
answers | jsonb | read, write | Answers |
screen_score | numeric | read only | Screen score |
screen_summary | text | read only | Screen summary |
screen_summary_local | text | read only | Screen summary local |
screen_concerns | _text | read only | Screen concerns |
screened_at | timestamp with time zone | read only | Screened at |
status | text | read, write | Status |
candidate_id | uuid | read only | Candidate id |
submission_id | uuid | read only | Submission id |
rejected_reason | text | read, write | Rejected because |
reviewed_by | uuid | read only | Reviewed by |
reviewed_at | timestamp with time zone | read only | Reviewed at |
applied_at | timestamp with time zone | read, write | Applied |
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 |
resume_parsed | jsonb | read only | Resume parsed |
screen_detail | jsonb | read only | Screen detail |
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 › Board Applications 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.