FlowmageDocs

List users

BetaReads dataVersion 2

Lists the recruiters and hiring managers in Teamtailor.

Settings

SettingWhat it is
ConnectionRequiredThe Teamtailor connection the step signs in with.
E-mailThe exact-match lookup for one colleague.
Department idPicked from the list Teamtailor offers.
External idThe id your own HR system knows this person by.
Also fetchRelated records to fetch with each row, comma separated. They arrive folded into the row.
Sort byA minus in front turns the order around.
Rows per call1 to 30 — Teamtailor's own maximum is 30.
Fetch every pageFollows Teamtailor's own next-page link, and refuses past 5,000 people 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 `teamtailor`)
emailtext
departmenttexta value from the vendor's own list
externalIdtext
includetext
sorttext
pageSizenumber, by default 30
returnAlltrue/false, by default false
cursortext

Output

FieldType
itemsPeoplearray
itemCountPeople in this answernumber
recordCountPeople matching the filter (all pages)number
hasMoreMore rows are waiting behind this pageboolean
nextUrlTeamtailor's own next-page addressstring
rawThe untouched JSON:API answerobject
nextCursorCursor for the next pagestring
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": {
    "connection": "<connection id>",
    "cursor": "",
    "department": "",
    "email": "",
    "externalId": "",
    "include": "",
    "pageSize": 30,
    "returnAll": false,
    "sort": ""
  },
  "label": "List users",
  "type": "teamtailor.listUsers",
  "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 Teamtailor connection the step signs in with.
E-mailThe exact-match lookup for one colleague.
Department idPicked from the list Teamtailor offers.
External idThe id your own HR system knows this person by.
Also fetchRelated records to fetch with each row, comma separated. They arrive folded into the row.
Sort byA minus in front turns the order around.
Rows per call1 to 30 — Teamtailor's own maximum is 30.
Fetch every pageFollows Teamtailor's own next-page link, and refuses past 5,000 people rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `teamtailor`)
emailtext
departmenttexta value from the vendor's own list
externalIdtext
includetext
sorttext
pageSizenumber, by default 30
returnAlltrue/false, by default false