FlowmageDocs

List employees

BetaReads data

Lists Personio employees, with filters on name, e-mail, status and change date.

Settings

SettingWhat it is
ConnectionRequiredThe Personio connection the step signs in with.
Employee idsOne or more Personio person ids, comma-separated.
E-mailtext
First nameExact match — Personio does not search on part of a name.
Last nametext
Preferred nametext
Status"" or "ACTIVE" or "INACTIVE"
Changed afterThe delta filter to build a sync on.
Changed beforetext
Created aftertext
CursorReads the page after a previous run: paste that run's Next cursor. Leave it empty for the first page.
Employees per call1 to 50.
Fetch every pageFollows Personio's next-page cursor, and refuses past 5,000 employees rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `personio`)
idstext
emailtext
firstNametext
lastNametext
preferredNametext
status"" or "ACTIVE" or "INACTIVE"
updatedAftertext
updatedBeforetext
createdAftertext
cursortext
limitnumber, by default 50
returnAlltrue/false, by default false

Output

FieldType
personsEmployeesarray
personCountEmployees in this answernumber
hasMoreMore employees are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • hasMorefalse
  • nextCursor""
  • personCount0
  • persons[]

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>",
    "createdAfter": "",
    "cursor": "",
    "email": "",
    "firstName": "",
    "ids": "",
    "lastName": "",
    "limit": 50,
    "preferredName": "",
    "returnAll": false,
    "status": "",
    "updatedAfter": "",
    "updatedBefore": ""
  },
  "label": "List employees",
  "type": "personio.listPersons",
  "version": 1
}