FlowmageDocs

List stages

BetaReads dataVersion 2

Lists the stages of a Teamtailor job's pipeline, in order.

Settings

SettingWhat it is
ConnectionRequiredThe Teamtailor connection the step signs in with.
Job idFill this in: Teamtailor only sorts stages by their board order when the list is narrowed to one job.
Stage type"" or "Inbox" or "In process" or "Hired"
Also fetchtext
Sort byrow-order is the board's own order, and only sorts right inside one job.
Stages per call1 to 30 — Teamtailor's own maximum is 30.
Fetch every pageFollows Teamtailor's own next-page link, and refuses past 5,000 stages 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`)
jobIdtext
stageType"" or "Inbox" or "In process" or "Hired"
includetext
sorttext, by default "row-order"
pageSizenumber, by default 30
returnAlltrue/false, by default true
cursortext

Output

FieldType
itemsStagesarray
itemCountStages in this answernumber
recordCountStages matching the filter (all pages)number
hasMoreMore stages 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": "",
    "include": "",
    "jobId": "",
    "pageSize": 30,
    "returnAll": true,
    "sort": "row-order",
    "stageType": ""
  },
  "label": "List stages",
  "type": "teamtailor.listStages",
  "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.
Job idFill this in: Teamtailor only sorts stages by their board order when the list is narrowed to one job.
Stage type"" or "Inbox" or "In process" or "Hired"
Also fetchtext
Sort byrow-order is the board's own order, and only sorts right inside one job.
Stages per call1 to 30 — Teamtailor's own maximum is 30.
Fetch every pageFollows Teamtailor's own next-page link, and refuses past 5,000 stages rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `teamtailor`)
jobIdtext
stageType"" or "Inbox" or "In process" or "Hired"
includetext
sorttext, by default "row-order"
pageSizenumber, by default 30
returnAlltrue/false, by default true