Talent & Contingent Workforce · Advertising
Job Board Contracts
What this desk pays for, how many slots are left, and what each contract has actually produced. Very few boards hand out a general posting API — the ones that do not are advertised through a feed or by hand, and the console says which.
/api/ats/job-board-connectionsPublished as /api/v1/job-board-connectionsDownload specification (OpenAPI 3.1) Screen: Job Board Contracts
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 › Job Board Contracts 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_board_connections · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ats/job-board-connectionsList job board contracts
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",
"board_code": "BOA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_account": "text",
"base_url": "https://example.com",
"auth_type": "text",
"client_id": "text",
"credential_cipher": "text",
"credential_last4": "text",
"token_expires_at": "2026-10-30T09:00:00Z",
"feed_path": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/ats/job-board-connections?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/ats/job-board-connections/{id}Read one job board contract
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",
"board_code": "BOA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_account": "text",
"base_url": "https://example.com",
"auth_type": "text",
"client_id": "text",
"credential_cipher": "text",
"credential_last4": "text",
"token_expires_at": "2026-10-30T09:00:00Z",
"feed_path": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/ats/job-board-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/job-board-connectionsCreate a job board contract
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
board_code | text | Yes | Board |
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
external_account | text | No | Account id over there |
base_url | text | No | Base address |
auth_type | text | No | Authentication |
client_id | text | No | Client id |
feed_path | text | No | Feed path — For a board that reads a feed rather than being posted to. The URL is the product for those boards. |
contract_slots | integer | No | Slots bought |
cost_per_post | numeric | No | Cost per post |
currency | text | No | Currency |
contract_from | date | No | From |
contract_to | date | No | Until |
default_duration_days | integer | No | Advertisement runs for (days) |
auto_repost | boolean | No | Repost automatically |
status | text | No | Status Allowed: draft testing active suspended error expired |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"board_code": "BOA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_account": "text",
"base_url": "https://example.com",
"auth_type": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_account": "text",
"base_url": "https://example.com",
"auth_type": "text",
"client_id": "text",
"credential_cipher": "text",
"credential_last4": "text",
"token_expires_at": "2026-10-30T09:00:00Z",
"feed_path": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/ats/job-board-connections" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"board_code":"BOA-000001","code":"COD-000001","name":"Example","name_local":"Example","external_account":"text","base_url":"https://example.com","auth_type":"text"}'PUT/api/ats/job-board-connections/{id}Change a job board contract
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 |
|---|---|---|---|
board_code | text | Yes | Board |
code | text | Yes | Code |
name | text | Yes | Name |
name_local | text | No | Local name |
external_account | text | No | Account id over there |
base_url | text | No | Base address |
auth_type | text | No | Authentication |
client_id | text | No | Client id |
feed_path | text | No | Feed path — For a board that reads a feed rather than being posted to. The URL is the product for those boards. |
contract_slots | integer | No | Slots bought |
cost_per_post | numeric | No | Cost per post |
currency | text | No | Currency |
contract_from | date | No | From |
contract_to | date | No | Until |
default_duration_days | integer | No | Advertisement runs for (days) |
auto_repost | boolean | No | Repost automatically |
status | text | No | Status Allowed: draft testing active suspended error expired |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"board_code": "BOA-000001",
"code": "COD-000001"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"board_code": "BOA-000001",
"code": "COD-000001",
"name": "Example",
"name_local": "Example",
"external_account": "text",
"base_url": "https://example.com",
"auth_type": "text",
"client_id": "text",
"credential_cipher": "text",
"credential_last4": "text",
"token_expires_at": "2026-10-30T09:00:00Z",
"feed_path": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/ats/job-board-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"board_code":"BOA-000001","code":"COD-000001"}'DELETE/api/ats/job-board-connections/{id}Delete a job board contract
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-board-connections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/job-board-connections/{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-board-connections/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 board contract, 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 |
board_code | text | read, write | Board |
code | text | read, write | Code |
name | text | read, write | Name |
name_local | text | read, write | Local name |
external_account | text | read, write | Account id over there |
base_url | text | read, write | Base address |
auth_type | text | read, write | Authentication |
client_id | text | read, write | Client id |
credential_cipher | bytea | read only | Credential cipher |
credential_last4 | text | read only | Credential last4 |
token_expires_at | timestamp with time zone | read only | Token expires at |
feed_path | text | read, write | Feed path — For a board that reads a feed rather than being posted to. The URL is the product for those boards. |
feed_token | text | read only | Feed token |
contract_slots | integer | read, write | Slots bought |
slots_used | integer | read only | Slots used |
cost_per_post | numeric | read, write | Cost per post |
currency | text | read, write | Currency |
contract_from | date | read, write | From |
contract_to | date | read, write | Until |
default_duration_days | integer | read, write | Advertisement runs for (days) |
auto_repost | boolean | read, write | Repost automatically |
status | text | read, write | Status Allowed: draft testing active suspended error expired |
last_checked_at | timestamp with time zone | read only | Last checked at |
last_error | text | read only | Last error |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
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 Board Contracts 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.