TeamtailorList candidates
Finds Teamtailor candidates by e-mail, department, location or date.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Teamtailor connection the step signs in with. |
| Teamtailor keys candidates by e-mail — this is the exact-match lookup. | |
| Department id | Picked from the list Teamtailor offers. |
| Division id | text |
| Role id | text |
| Location ids | text |
| Region ids | text |
| City | text |
| Country | text |
| State | text |
| Phone | text |
| Connected | "" or "true" or "false" |
| Created from | text |
| Created up to | text |
| Changed from | The filter a nightly sync reads — everything touched since this moment. |
| Changed up to | text |
| Also fetch | Related records to fetch with each candidate, comma separated. They arrive folded into each row, so {{ candidate.department.name }} works. |
| Sort by | A minus in front turns the order around. |
| Candidates per call | 1 to 30 — Teamtailor's own maximum is 30. |
| Fetch every page | Follows Teamtailor's own next-page link, and refuses past 5,000 candidates rather than answering a short list. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `teamtailor`) |
email | text |
department | texta value from the vendor's own list |
division | text |
role | text |
locations | text |
regions | text |
city | text |
country | text |
state | text |
phone | text |
connected | "" or "true" or "false" |
createdFrom | text |
createdTo | text |
updatedFrom | text |
updatedTo | text |
include | text |
sort | text, by default "-id" |
pageSize | number, by default 30 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
itemsCandidates | array |
itemCountCandidates in this answer | number |
recordCountCandidates matching the filter (all pages) | number |
hasMoreMore candidates are waiting behind this page | boolean |
nextUrlTeamtailor's own next-page address | string |
rawThe untouched JSON:API answer | object |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- itemCount0
- items[]
- nextUrl""
- raw
- data[]
- included[]
- linksnull
- metanull
- recordCount0
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": {
"city": "",
"connected": "",
"connection": "<connection id>",
"country": "",
"createdFrom": "",
"createdTo": "",
"cursor": "",
"department": "",
"division": "",
"email": "",
"include": "",
"locations": "",
"pageSize": 30,
"phone": "",
"regions": "",
"returnAll": false,
"role": "",
"sort": "-id",
"state": "",
"updatedFrom": "",
"updatedTo": ""
},
"label": "List candidates",
"type": "teamtailor.listCandidates",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The Teamtailor connection the step signs in with. |
| Teamtailor keys candidates by e-mail — this is the exact-match lookup. | |
| Department id | Picked from the list Teamtailor offers. |
| Division id | text |
| Role id | text |
| Location ids | text |
| Region ids | text |
| City | text |
| Country | text |
| State | text |
| Phone | text |
| Connected | "" or "true" or "false" |
| Created from | text |
| Created up to | text |
| Changed from | The filter a nightly sync reads — everything touched since this moment. |
| Changed up to | text |
| Also fetch | Related records to fetch with each candidate, comma separated. They arrive folded into each row, so {{ candidate.department.name }} works. |
| Sort by | A minus in front turns the order around. |
| Candidates per call | 1 to 30 — Teamtailor's own maximum is 30. |
| Fetch every page | Follows Teamtailor's own next-page link, and refuses past 5,000 candidates rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `teamtailor`) |
email | text |
department | texta value from the vendor's own list |
division | text |
role | text |
locations | text |
regions | text |
city | text |
country | text |
state | text |
phone | text |
connected | "" or "true" or "false" |
createdFrom | text |
createdTo | text |
updatedFrom | text |
updatedTo | text |
include | text |
sort | text, by default "-id" |
pageSize | number, by default 30 |
returnAll | true/false, by default false |