List employees
BetaReads data
Lists Personio employees, with filters on name, e-mail, status and change date.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Personio connection the step signs in with. |
| Employee ids | One or more Personio person ids, comma-separated. |
| text | |
| First name | Exact match — Personio does not search on part of a name. |
| Last name | text |
| Preferred name | text |
| Status | "" or "ACTIVE" or "INACTIVE" |
| Changed after | The delta filter to build a sync on. |
| Changed before | text |
| Created after | text |
| Cursor | Reads the page after a previous run: paste that run's Next cursor. Leave it empty for the first page. |
| Employees per call | 1 to 50. |
| Fetch every page | Follows Personio's next-page cursor, and refuses past 5,000 employees rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `personio`) |
ids | text |
email | text |
firstName | text |
lastName | text |
preferredName | text |
status | "" or "ACTIVE" or "INACTIVE" |
updatedAfter | text |
updatedBefore | text |
createdAfter | text |
cursor | text |
limit | number, by default 50 |
returnAll | true/false, by default false |
Output
| Field | Type |
|---|---|
personsEmployees | array |
personCountEmployees in this answer | number |
hasMoreMore employees are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
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
}