HiBob

Exchange data with the HiBob API

People → Search for Employees

AI-generated

Overview

This node integrates with the HiBob API to search for employee data within an organization. It allows users to query employee records based on customizable criteria and retrieve specific fields of interest. This is particularly useful for HR automation, reporting, or syncing employee information with other systems.

Typical use cases include:

Searching for employees by email or other attributes.
Retrieving selected employee details such as name, department, or status.
Filtering results to include or exclude inactive employees.
Formatting the response data in a human-readable way for easier consumption.

For example, you could use this node to find all active employees in a certain department and get their contact details for an internal directory update.

Properties

Name	Meaning
Fields	An optional list of employee fields to return in the response. If left empty, a default set of fields and categories will be returned. You can select from predefined fields or specify field IDs using expressions.
Additional Settings	A collection of optional settings to customize the search:
- Human Readable	Determines how human-readable data is included in the response: • Append: Add human-readable data alongside machine-readable values. • Replace: Return only human-readable values instead of machine-readable ones.
- Show Inactive	Boolean flag indicating whether to include inactive employees in the search results. Defaults to false (exclude inactive).
- Filter	A JSON object defining a filter condition to narrow down which employees are returned. For example, filtering by email equals a specific address. If omitted, all accessible employees are returned.

Output

The node outputs an array of JSON objects representing employee records matching the search criteria. Each item contains the requested fields and respects the formatting options specified (human-readable data appended or replacing machine-readable data).

If multiple employees match the search, each employee's data is output as a separate item in the array.

No binary data is produced by this node.

Example output structure snippet:

[
  {
    "id": "12345",
    "firstName": "Tom",
    "lastName": "Smith",
    "email": "tom@n8n.io",
    "status": "Active",
    ...
  },
  ...
]

Dependencies

Requires an API key credential for authenticating with the HiBob API.
The node makes HTTP requests to HiBob endpoints /v1/people/search for employee searches.
No additional external dependencies beyond the configured API authentication.

Troubleshooting

Empty results: Ensure your filter criteria are correct and that the service user has permission to access the requested employee data.
Invalid filter JSON: The Filter property must be valid JSON. Malformed JSON will cause errors.
API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
Field selection issues: If specifying fields, ensure they exist and are spelled correctly; otherwise, the API may ignore them or return defaults.
Handling large result sets: The node returns all matched employees in one execution; if many employees match, consider adding filters to limit results.

Common error messages typically relate to invalid parameters or authentication failures. Review the error message details and adjust input properties or credentials accordingly.

Links and References

HiBob API Reference - Search People
n8n Expressions Documentation (for dynamic field ID specification)

HiBobInstall