FlowmageDocs

Read company list

BetaReads data

Reads a HiBob company list, like sites, departments or titles.

Settings

SettingWhat it is
ConnectionRequiredThe HiBob connection the step signs in with.
List nameLeave empty to get every list Bob has. Pick one to get its items with their ids — the values Create employee and the table nodes want.
Include archived valuesOff, Bob leaves out values an admin has retired.
Technical details
KeyValue
connectiontexta connection id from `requires.connections` (provider `hibob`)
listNametexta value from the vendor's own list
includeArchivedtrue/false, by default false

Output

FieldType
listsarray
listCountLists in this answernumber
listThe list you asked forobject
itemsValues in the listarray
itemCountValues in the listnumber
Sample output, and the expression for each field
  • listCount0
  • lists[]

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>",
    "includeArchived": false,
    "listName": ""
  },
  "label": "Read company list",
  "type": "hibob.readCompanyList",
  "version": 1
}