TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/hrms/candidatesPublished as /api/v1/candidates

Download specification (OpenAPI 3.1) Screen: Candidates

Overview

PackageHRMS
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 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.
Tablehr.candidates · 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

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

GET/api/hrms/candidatesList candidates

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
first_nametextYesFirst name
last_nametextYesLast name
emailtextNoEmail
phonetextNoPhone
citytextNoCity
countrytextNoCountry
linkedin_urltextNoLinkedin url
current_employertextNoCurrent employer
current_titletextNoCurrent title
years_experiencenumericNoYears of experience
is_internalbooleanNoAlready works here
employee_iduuidNoEmployee record
sourcetextNoHow they came to us
referred_by_iduuidNoReferred by id
talent_pooltextNoTalent pool
ratingintegerNoRating
notestextNoNotes
is_activebooleanNoActive

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

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
first_nametextYesFirst name
last_nametextYesLast name
emailtextNoEmail
phonetextNoPhone
citytextNoCity
countrytextNoCountry
linkedin_urltextNoLinkedin url
current_employertextNoCurrent employer
current_titletextNoCurrent title
years_experiencenumericNoYears of experience
is_internalbooleanNoAlready works here
employee_iduuidNoEmployee record
sourcetextNoHow they came to us
referred_by_iduuidNoReferred by id
talent_pooltextNoTalent pool
ratingintegerNoRating
notestextNoNotes
is_activebooleanNoActive

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

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

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

templateId, body, applicationId, subject, channel

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/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

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

email, sms, reason

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/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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
candidate_notextread onlyCandidate no
first_nametextread, writeFirst name
last_nametextread, writeLast name
emailtextread, writeEmail
phonetextread, writePhone
citytextread, writeCity
countrytextread, writeCountry
linkedin_urltextread, writeLinkedin url
current_employertextread, writeCurrent employer
current_titletextread, writeCurrent title
years_experiencenumericread, writeYears of experience
is_internalbooleanread, writeAlready works here
employee_iduuidread, writeEmployee record
sourcetextread, writeHow they came to us
referred_by_iduuidread, writeReferred by id
consent_given_ondateread onlyConsent given on
consent_expires_ondateread onlyConsent expires on
delete_afterdateread onlyDelete after
talent_pooltextread, writeTalent pool
ratingintegerread, writeRating
notestextread, writeNotes
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
email_opt_outbooleanread onlyEmail opt out
sms_opt_outbooleanread onlySms opt out
opted_out_attimestamp with time zoneread onlyOpted out at
opt_out_reasontextread onlyOpt out reason

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 HRMS › Candidates 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.