HiBobSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The HiBob connection the step signs in with. |
| Fields to fetch | Leave empty for Bob's default set (root, About, Employment and Work). The List employee fields node gives you every id; the common ones are root.id, root.email, root.firstName, root.surname, root.fullName, root.displayName, work.title, work.department, work.site, work.startDate, work.manager, work.reportsTo and work.isManager. Asking for fewer fields is how you keep a big company's answer inside this run's size limit — this endpoint returns every matching employee in one go and does not paginate. |
| Filter on | Bob supports exactly one filter, on the employee id or the e-mail, with equals. Anything else is a 400 — filter downstream instead. |
| Values to match | One or more ids or e-mail addresses. Bob matches any of them. |
| Include people who have left | Off, Bob answers only employees who are currently active. |
| List values | Bob stores list values as numeric ids. Readable values turns 1644513820829 into Amsterdam. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `hibob`) |
fields | text |
filterField | "" or "root.id" or "root.email" |
filterValues | textused when `filterField` is not "" |
showInactive | true/false, by default false |
humanReadable | "" or "APPEND" or "REPLACE" |
Output
| Field | Type |
|---|---|
employees | array |
employeeCountEmployees in this answer | number |
Sample output, and the expression for each field
- employeeCount0
- employees[]
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>",
"fields": "",
"filterField": "",
"filterValues": "",
"humanReadable": "",
"showInactive": false
},
"label": "Search employees",
"type": "hibob.searchEmployees",
"version": 1
}