FlowmageDocs

Find candidates

BetaReads dataVersion 2

Finds candidates in Recruitee by name, email, tag or CV content.

Settings

SettingWhat it is
ConnectionRequiredThe Recruitee connection the step signs in with.
SearchFree text — Recruitee searches names, e-mail addresses, phone numbers, tags, sources, cover letters and CV contents.
FiltersRecruitee's own filters_json value. Time filters take Unix timestamps.
Sort by"created_at_desc" or "created_at_asc" or "updated_at_desc" or "updated_at_asc"
Candidates per call1 to 1,000. Recruitee allows up to 10,000 but one node output cannot carry that. With Fetch every page on, this is the page size.
PageWhich page to read when Fetch every page is off.
Fetch every pagePages until Recruitee runs out, and refuses past 10,000 candidates rather than answering a short list.
CursorPaste a previous run's Next cursor to read the page after it.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `recruitee`)
querytext
filtersany JSON
sortBy"created_at_desc" or "created_at_asc" or "updated_at_desc" or "updated_at_asc", by default "created_at_desc"
limitnumber, by default 60
pagenumber, by default 1
returnAlltrue/false, by default false
cursortext

Output

FieldType
candidatesarray
candidateCountCandidates in this answernumber
totalHow many Recruitee found in totalnumber
hasMoreMore candidates are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • candidateCount0
  • candidates[]
  • hasMorefalse
  • total0

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": {
    "connection": "<connection id>",
    "cursor": "",
    "limit": 60,
    "page": 1,
    "query": "",
    "returnAll": false,
    "sortBy": "created_at_desc"
  },
  "label": "Find candidates",
  "type": "recruitee.findCandidates",
  "version": 2
}

Older versions

A flow that already has this version keeps running it. A new step always gets the newest.

Version 1
SettingWhat it is
ConnectionRequiredThe Recruitee connection the step signs in with.
SearchFree text — Recruitee searches names, e-mail addresses, phone numbers, tags, sources, cover letters and CV contents.
FiltersRecruitee's own filters_json value. Time filters take Unix timestamps.
Sort by"created_at_desc" or "created_at_asc" or "updated_at_desc" or "updated_at_asc"
Candidates per call1 to 1,000. Recruitee allows up to 10,000 but one node output cannot carry that. With Fetch every page on, this is the page size.
PageWhich page to read when Fetch every page is off.
Fetch every pagePages until Recruitee runs out, and refuses past 10,000 candidates rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `recruitee`)
querytext
filtersany JSON
sortBy"created_at_desc" or "created_at_asc" or "updated_at_desc" or "updated_at_asc", by default "created_at_desc"
limitnumber, by default 60
pagenumber, by default 1
returnAlltrue/false, by default false