FlowmageDocs

List documents

BetaReads data

Lists the documents filed on one Personio employee.

Settings

SettingWhat it is
ConnectionRequiredThe Personio connection the step signs in with.
Employee idRequiredRequired — Personio only answers per employee. The person id is the owner id.
Category idtext
Filed on or aftertext
Filed beforetext
CursorPaste a previous run's Next cursor to read the page after it.
Documents per call1 to 200.
Fetch every pageFollows Personio's next-page cursor, and refuses past 5,000 documents rather than answering a short list.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `personio`)
ownerIdtext
categoryIdtext
createdFromtext
createdBeforetext
cursortext
limitnumber, by default 100
returnAlltrue/false, by default false

Output

FieldType
documentsarray
documentCountDocuments in this answernumber
hasMoreMore documents are waiting behind this pageboolean
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • documentCount0
  • documents[]
  • hasMorefalse
  • nextCursor""

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": {
    "categoryId": "",
    "connection": "<connection id>",
    "createdBefore": "",
    "createdFrom": "",
    "cursor": "",
    "limit": 100,
    "ownerId": "<employee id>",
    "returnAll": false
  },
  "label": "List documents",
  "type": "personio.listDocuments",
  "version": 1
}