FlowmageDocs

Get candidate

BetaReads data

Fetches one Teamtailor candidate, with the related records you ask for.

Settings

SettingWhat it is
ConnectionRequiredThe Teamtailor connection the step signs in with.
Candidate idRequiredThe List candidates node gives you the id.
Also fetchRelated records to fetch with the candidate, comma separated. They arrive folded into the answer, so {{ candidate.department.name }} works.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `teamtailor`)
candidateIdtext
includetext, by default "job-applications"

Output

FieldType
candidateobject
rawThe untouched JSON:API answerobject
Sample output, and the expression for each field
  • candidate
    • id"c-1"
    • type"candidates"
  • raw
    • data{}
    • included[]

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "candidateId": "<candidate id>",
    "connection": "<connection id>",
    "include": "job-applications"
  },
  "label": "Get candidate",
  "type": "teamtailor.getCandidate",
  "version": 1
}