TRANXACT.AI Help

Talent & Contingent Workforce · Talent

Contingent Candidates

The database, which in a staffing business is the asset. Right to work and its expiry are columns rather than notes, because a contractor whose permission runs out mid-assignment is the most expensive mistake in this module.

Type REST21 operationsBase path /api/ats/candidatesPublished as /api/v1/candidates

Download specification (OpenAPI 3.1) Screen: Contingent Candidates

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 › Contingent 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.
Tableats.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

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

GET/api/ats/candidatesList contingent 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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "candidate_no": "CAN-000001",
      "first_name": "Example",
      "last_name": "Example",
      "preferred_name": "Example",
      "name_local": "Example",
      "email": "someone@example.com",
      "phone": "+1 555 0100",
      "mobile": "+1 555 0100",
      "address": "text",
      "city": "text",
      "state": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ats/candidates?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/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",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_no": "CAN-000001",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "name_local": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "mobile": "+1 555 0100",
  "address": "text",
  "city": "text",
  "state": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
location_iduuidNoOffice
first_nametextYesFirst name
last_nametextYesLast name
preferred_nametextNoPreferred name
name_localtextNoLocal name
emailtextNoEmail
phonetextNoPhone
mobiletextNoMobile
addresstextNoAddress
citytextNoCity
statetextNoState or province
countrytextNoCountry
postal_codetextNoPostal code
current_titletextNoCurrent title
current_employertextNoCurrent employer
total_experience_yearsnumericNoExperience (years)
education_leveltextNoEducation
linkedin_urltextNoLinkedIn
sourcetextNoSource
source_detailtextNoSource detail
referred_bytextNoReferred by
owner_recruiter_iduuidNoOwning recruiter
work_authorizationtextNoRight to work
work_auth_expires_ondateNoRight to work expires — Watched by the compliance sweep. Blank means it does not expire — not that nobody checked.
employment_preferencetextNoPrefers to work as
supplier_iduuidNoThrough supplier — For a corp-to-corp candidate: the company they come through, and the one that gets paid.
willing_to_relocatebooleanNoWill relocate
willing_remotebooleanNoWill work remotely
availability_datedateNoAvailable from
notice_period_daysintegerNoNotice period (days)
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
desired_pay_ratenumericNoWants (rate)
desired_salarynumericNoWants (salary)
statustextNoStatus
ratingintegerNoRating
resume_summarytextNoSummary
notestextNoNotes
employee_iduuidNoEmployee record — Set when a contractor converts, or when an existing employee is also a candidate.
student_iduuidNoStudent record — A placement against this candidate writes back to the student’s own career record.
user_iduuidNoPortal sign-in
consent_given_ondateNoConsent given — "We have had their CV since 2019" is not a lawful basis for holding it.
consent_sourcetextNoConsent source
do_not_contactbooleanNoDo not contact
is_activebooleanNoActive

Sample body

{
  "first_name": "Example",
  "last_name": "Example",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "preferred_name": "Example",
  "name_local": "Example",
  "email": "someone@example.com"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_no": "CAN-000001",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "name_local": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "mobile": "+1 555 0100",
  "address": "text",
  "city": "text",
  "state": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/candidates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Example","last_name":"Example","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","preferred_name":"Example","name_local":"Example","email":"someone@example.com"}'
PUT/api/ats/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
location_iduuidNoOffice
first_nametextYesFirst name
last_nametextYesLast name
preferred_nametextNoPreferred name
name_localtextNoLocal name
emailtextNoEmail
phonetextNoPhone
mobiletextNoMobile
addresstextNoAddress
citytextNoCity
statetextNoState or province
countrytextNoCountry
postal_codetextNoPostal code
current_titletextNoCurrent title
current_employertextNoCurrent employer
total_experience_yearsnumericNoExperience (years)
education_leveltextNoEducation
linkedin_urltextNoLinkedIn
sourcetextNoSource
source_detailtextNoSource detail
referred_bytextNoReferred by
owner_recruiter_iduuidNoOwning recruiter
work_authorizationtextNoRight to work
work_auth_expires_ondateNoRight to work expires — Watched by the compliance sweep. Blank means it does not expire — not that nobody checked.
employment_preferencetextNoPrefers to work as
supplier_iduuidNoThrough supplier — For a corp-to-corp candidate: the company they come through, and the one that gets paid.
willing_to_relocatebooleanNoWill relocate
willing_remotebooleanNoWill work remotely
availability_datedateNoAvailable from
notice_period_daysintegerNoNotice period (days)
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
desired_pay_ratenumericNoWants (rate)
desired_salarynumericNoWants (salary)
statustextNoStatus
ratingintegerNoRating
resume_summarytextNoSummary
notestextNoNotes
employee_iduuidNoEmployee record — Set when a contractor converts, or when an existing employee is also a candidate.
student_iduuidNoStudent record — A placement against this candidate writes back to the student’s own career record.
user_iduuidNoPortal sign-in
consent_given_ondateNoConsent given — "We have had their CV since 2019" is not a lawful basis for holding it.
consent_sourcetextNoConsent source
do_not_contactbooleanNoDo not contact
is_activebooleanNoActive

Sample body

{
  "first_name": "Example",
  "last_name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_no": "CAN-000001",
  "first_name": "Example",
  "last_name": "Example",
  "preferred_name": "Example",
  "name_local": "Example",
  "email": "someone@example.com",
  "phone": "+1 555 0100",
  "mobile": "+1 555 0100",
  "address": "text",
  "city": "text",
  "state": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ats/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Example","last_name":"Example"}'
DELETE/api/ats/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/ats/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/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/ats/candidates/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/candidates/{parentId}/skillsSkills

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

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

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

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

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

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

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

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

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

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

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

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

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

jobOrderId, resumeText

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/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/summarise" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jobOrderId":"value","resumeText":"value"}'
GET/api/ats/candidates/{id}/previewPreview

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/candidates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/candidates/from-student/{id}From student

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

recruiterId

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/candidates/from-student/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recruiterId":"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
org_unit_iduuidread onlyOrg unit id
location_iduuidread, writeOffice
candidate_notextread onlyCandidate no
first_nametextread, writeFirst name
last_nametextread, writeLast name
preferred_nametextread, writePreferred name
name_localtextread, writeLocal name
emailtextread, writeEmail
phonetextread, writePhone
mobiletextread, writeMobile
addresstextread, writeAddress
citytextread, writeCity
statetextread, writeState or province
countrytextread, writeCountry
postal_codetextread, writePostal code
current_titletextread, writeCurrent title
current_employertextread, writeCurrent employer
total_experience_yearsnumericread, writeExperience (years)
education_leveltextread, writeEducation
linkedin_urltextread, writeLinkedIn
sourcetextread, writeSource
source_detailtextread, writeSource detail
referred_bytextread, writeReferred by
owner_recruiter_iduuidread, writeOwning recruiter
work_authorizationtextread, writeRight to work
work_auth_expires_ondateread, writeRight to work expires — Watched by the compliance sweep. Blank means it does not expire — not that nobody checked.
employment_preferencetextread, writePrefers to work as
supplier_iduuidread, writeThrough supplier — For a corp-to-corp candidate: the company they come through, and the one that gets paid.
willing_to_relocatebooleanread, writeWill relocate
willing_remotebooleanread, writeWill work remotely
availability_datedateread, writeAvailable from
notice_period_daysintegerread, writeNotice period (days)
currencytextread, writeCurrency
rate_unittextread, writeRate unit
Allowed: hour day week month year fixed
desired_pay_ratenumericread, writeWants (rate)
desired_salarynumericread, writeWants (salary)
statustextread, writeStatus
ratingintegerread, writeRating
resume_summarytextread, writeSummary
notestextread, writeNotes
employee_iduuidread, writeEmployee record — Set when a contractor converts, or when an existing employee is also a candidate.
student_iduuidread, writeStudent record — A placement against this candidate writes back to the student’s own career record.
user_iduuidread, writePortal sign-in
consent_given_ondateread, writeConsent given — "We have had their CV since 2019" is not a lawful basis for holding it.
consent_sourcetextread, writeConsent source
do_not_contactbooleanread, writeDo not contact
last_contacted_attimestamp with time zoneread onlyLast contacted at
is_activebooleanread, writeActive
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 › Contingent 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.