HRMS · Recruiting & Onboarding
Candidates
Everybody who has been in front of this company for a post, whether they applied or were found. Somebody already employed here is marked internal, which is what makes an internal move visible as one.
/api/hrms/candidatesPublished as /api/v1/candidatesOverview
| Package | HRMS |
|---|---|
| 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 HRMS › Candidates 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 | hr.candidates · 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/hrms/candidatesList candidates
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",
"candidate_no": "CAN-000001",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"city": "text",
"country": "US",
"linkedin_url": "https://example.com",
"current_employer": "text",
"current_title": "Example",
"years_experience": "1250.00",
"is_internal": true,
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/candidates?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/candidates/{id}Read one candidates
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",
"candidate_no": "CAN-000001",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"city": "text",
"country": "US",
"linkedin_url": "https://example.com",
"current_employer": "text",
"current_title": "Example",
"years_experience": "1250.00",
"is_internal": true,
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/candidatesCreate a candidates
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
first_name | text | Yes | First name |
last_name | text | Yes | Last name |
email | text | No | |
phone | text | No | Phone |
city | text | No | City |
country | text | No | Country |
linkedin_url | text | No | Linkedin url |
current_employer | text | No | Current employer |
current_title | text | No | Current title |
years_experience | numeric | No | Years of experience |
is_internal | boolean | No | Already works here |
employee_id | uuid | No | Employee record |
source | text | No | How they came to us |
referred_by_id | uuid | No | Referred by id |
talent_pool | text | No | Talent pool |
rating | integer | No | Rating |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"city": "text",
"country": "US"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"candidate_no": "CAN-000001",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"city": "text",
"country": "US",
"linkedin_url": "https://example.com",
"current_employer": "text",
"current_title": "Example",
"years_experience": "1250.00",
"is_internal": true,
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/candidates" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"first_name":"Example","last_name":"Example","email":"someone@example.com","phone":"+1 555 0100","city":"text","country":"US"}'PUT/api/hrms/candidates/{id}Change a candidates
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 |
|---|---|---|---|
first_name | text | Yes | First name |
last_name | text | Yes | Last name |
email | text | No | |
phone | text | No | Phone |
city | text | No | City |
country | text | No | Country |
linkedin_url | text | No | Linkedin url |
current_employer | text | No | Current employer |
current_title | text | No | Current title |
years_experience | numeric | No | Years of experience |
is_internal | boolean | No | Already works here |
employee_id | uuid | No | Employee record |
source | text | No | How they came to us |
referred_by_id | uuid | No | Referred by id |
talent_pool | text | No | Talent pool |
rating | integer | No | Rating |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"first_name": "Example",
"last_name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"candidate_no": "CAN-000001",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"phone": "+1 555 0100",
"city": "text",
"country": "US",
"linkedin_url": "https://example.com",
"current_employer": "text",
"current_title": "Example",
"years_experience": "1250.00",
"is_internal": true,
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"first_name":"Example","last_name":"Example"}'DELETE/api/hrms/candidates/{id}Delete a candidates
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/hrms/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/candidates/{id}/messageMessage
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):
templateId, body, applicationId, subject, channelResponse
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/hrms/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/message" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"templateId":"value","body":"value","applicationId":"value","subject":"value","channel":"value"}'POST/api/hrms/candidates/{id}/opt-outOpt out
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):
email, sms, reasonResponse
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/hrms/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/opt-out" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"email":"value","sms":"value","reason":"value"}'POST/api/hrms/candidates/{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/hrms/candidates/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 candidates, 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 |
candidate_no | text | read only | Candidate no |
first_name | text | read, write | First name |
last_name | text | read, write | Last name |
email | text | read, write | |
phone | text | read, write | Phone |
city | text | read, write | City |
country | text | read, write | Country |
linkedin_url | text | read, write | Linkedin url |
current_employer | text | read, write | Current employer |
current_title | text | read, write | Current title |
years_experience | numeric | read, write | Years of experience |
is_internal | boolean | read, write | Already works here |
employee_id | uuid | read, write | Employee record |
source | text | read, write | How they came to us |
referred_by_id | uuid | read, write | Referred by id |
consent_given_on | date | read only | Consent given on |
consent_expires_on | date | read only | Consent expires on |
delete_after | date | read only | Delete after |
talent_pool | text | read, write | Talent pool |
rating | integer | read, write | Rating |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
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 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
email_opt_out | boolean | read only | Email opt out |
sms_opt_out | boolean | read only | Sms opt out |
opted_out_at | timestamp with time zone | read only | Opted out at |
opt_out_reason | text | read only | Opt out reason |
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 HRMS › Candidates 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.