> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/hibob.md).

# HiBob

HiBob (Bob) is an HR platform. Search, read, create and update employees, read time off requests and who's out, and look up field and list metadata from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| HiBob     | Credentials    |

#### HiBob

Connect to HiBob with an API service user to read and update employees and read time off.

**Set up in HiBob**

1. Prepare the HiBob account or service that the workflow will access. Grant access to the required resources and operations.
2. **Service User ID:** The ID of an API service user, created by a Bob admin under Settings > Integrations > Automation > Service Users.
3. **Token:** The service user's token, shown once when the service user is created. The service user must belong to a permission group with View (and Edit, for updates) on the People's fields each action reads or writes, 'Add new people' for Create Employee, and 'See who's out' for the time off actions.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **HiBob**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field   | Required | What to enter                                                                                                                                                                                                                                                                                                                                                                 |
| --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Service User ID | Yes      | The ID of an API service user, created by a Bob admin under Settings > Integrations > Automation > Service Users. [Provider instructions](https://apidocs.hibob.com/docs/api-service-users).                                                                                                                                                                                  |
| Token           | Yes      | The service user's token, shown once when the service user is created. The service user must belong to a permission group with View (and Edit, for updates) on the People's fields each action reads or writes, 'Add new people' for Create Employee, and 'See who's out' for the time off actions. [Provider instructions](https://apidocs.hibob.com/reference/permissions). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **HiBob** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Search Employees

List HiBob employees with chosen fields, optionally filtered by id or email.

**Inputs**

| Field            | Type                      | Required | Description                                                                                                                                   |
| ---------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Fields           | multiple\_select (string) | No       | Employee fields to return (dot-notation ids). Defaults to identity, work and status fields. Options load from the selected connection.        |
| Filter By        | select (string)           | No       | Which identifier the filter values match. Available values: Employee id (root.id), Work email (root.email). Default: root.id.                 |
| Filter Values    | array                     | No       | Employee ids or emails to return; leave empty for everyone.                                                                                   |
| Include Inactive | boolean                   | No       | Also return terminated and other inactive employees. Default: false.                                                                          |
| Human Readable   | select (string)           | No       | Return list values as display names instead of ids. Available values: Replace ids with display names, Append display names. Default: REPLACE. |
| Offset           | integer                   | No       | Skip this many rows; pass a previous call's next\_offset. Minimum: 0. Default: 0.                                                             |
| Limit            | integer                   | No       | Maximum number of rows to return. Minimum: 1. Maximum: 500. Default: 100.                                                                     |

**Outputs**

| Field       | Type        | Description                                             |
| ----------- | ----------- | ------------------------------------------------------- |
| Employees   | dict\_array | The matching employees with the requested fields.       |
| Count       | integer     | Number of rows returned (may be capped; see has\_more). |
| Has More    | boolean     | True if more rows exist beyond the returned set.        |
| Next Offset | integer     | Pass this back as Offset to continue, if present.       |

#### Get Employee

Read a single HiBob employee's fields by id or email.

**Inputs**

| Field          | Type                      | Required | Description                                                                                                                                   |
| -------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| Employee       | select (string)           | Yes      | Pick an employee, or paste an employee id or work email. Options load from the selected connection.                                           |
| Fields         | multiple\_select (string) | No       | Employee fields to return (dot-notation ids). Defaults to identity, work and status fields. Options load from the selected connection.        |
| Human Readable | select (string)           | No       | Return list values as display names instead of ids. Available values: Replace ids with display names, Append display names. Default: REPLACE. |

**Outputs**

| Field        | Type   | Description                                    |
| ------------ | ------ | ---------------------------------------------- |
| Employee     | dict   | The employee object with the requested fields. |
| Employee ID  | string | The employee's backend id.                     |
| Display Name | string | The employee's display name, when available.   |
| Email        | string | The employee's work email, when available.     |

#### Create Employee

Create a new HiBob employee with name, email, site and start date.

**Inputs**

| Field             | Type            | Required | Description                                                                                                |
| ----------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
| First Name        | string          | Yes      | The employee's first name (max 50 characters).                                                             |
| Surname           | string          | Yes      | The employee's surname (max 50 characters).                                                                |
| Email             | string          | Yes      | The employee's work email; must be unique in the company.                                                  |
| Site              | select (string) | Yes      | The employee's site: an existing item of the 'site' list. Options load from the selected connection.       |
| Start Date        | date            | Yes      | The employment start date (YYYY-MM-DD).                                                                    |
| Department        | select (string) | No       | Optional department: an existing item of the 'department' list. Options load from the selected connection. |
| Job Title         | select (string) | No       | Optional job title: an existing item of the 'title' list. Options load from the selected connection.       |
| Additional Fields | object          | No       | Optional extra fields as nested JSON by category, e.g. {"home": {"mobilePhone": "..."}}.                   |

**Outputs**

| Field        | Type   | Description                                         |
| ------------ | ------ | --------------------------------------------------- |
| Employee ID  | string | The backend id of the created employee.             |
| Display Name | string | The display name HiBob derived from the name parts. |
| Email        | string | The employee's email.                               |
| Employee     | dict   | The full created employee record.                   |

#### Update Employee

Change fields on an existing HiBob employee; other fields stay untouched.

**Inputs**

| Field    | Type            | Required | Description                                                                                                              |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| Employee | select (string) | Yes      | Pick an employee, or paste an employee id or work email. Options load from the selected connection.                      |
| Fields   | object          | Yes      | The fields to change as nested JSON by category, e.g. {"home": {"mobilePhone": "..."}}. Other fields are left unchanged. |

**Outputs**

| Field          | Type    | Description                                                   |
| -------------- | ------- | ------------------------------------------------------------- |
| Employee ID    | string  | The backend id of the updated employee.                       |
| Updated        | boolean | False when HiBob reported nothing changed (304 Not Modified). |
| Updated Fields | array   | The top-level keys that were sent.                            |

#### Get Time Off Request Changes

List time off requests that were created, cancelled or deleted since a date.

**Inputs**

| Field           | Type     | Required | Description                                                                       |
| --------------- | -------- | -------- | --------------------------------------------------------------------------------- |
| Since           | datetime | Yes      | Return requests changed on or after this moment (UTC).                            |
| To              | datetime | No       | Optional end of the change window (UTC).                                          |
| Include Pending | boolean  | No       | Also include requests that changed to pending approval. Default: false.           |
| Offset          | integer  | No       | Skip this many rows; pass a previous call's next\_offset. Minimum: 0. Default: 0. |
| Limit           | integer  | No       | Maximum number of rows to return. Minimum: 1. Maximum: 500. Default: 100.         |

**Outputs**

| Field       | Type        | Description                                             |
| ----------- | ----------- | ------------------------------------------------------- |
| Changes     | dict\_array | The time off request changes in the window.             |
| Count       | integer     | Number of rows returned (may be capped; see has\_more). |
| Has More    | boolean     | True if more rows exist beyond the returned set.        |
| Next Offset | integer     | Pass this back as Offset to continue, if present.       |

#### Get Who's Out

List approved absences (who's out) between two dates.

**Inputs**

| Field                    | Type    | Required | Description                                                                                                                     |
| ------------------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| From                     | date    | Yes      | Start of the absence window (YYYY-MM-DD).                                                                                       |
| To                       | date    | Yes      | End of the absence window (YYYY-MM-DD).                                                                                         |
| Include Hourly           | boolean | No       | Include requests measured in hours. Default: false.                                                                             |
| Include Private          | boolean | No       | Include requests under private policies and show original policy names (needs the private-requests permission). Default: false. |
| Include Pending          | boolean | No       | Include requests still pending approval (needs the pending-requests permission). Default: false.                                |
| Include Working Requests | boolean | No       | Include 'working' policy types such as work from home or business travel. Default: false.                                       |
| Offset                   | integer | No       | Skip this many rows; pass a previous call's next\_offset. Minimum: 0. Default: 0.                                               |
| Limit                    | integer | No       | Maximum number of rows to return. Minimum: 1. Maximum: 500. Default: 100.                                                       |

**Outputs**

| Field       | Type        | Description                                             |
| ----------- | ----------- | ------------------------------------------------------- |
| Who's Out   | dict\_array | The absences overlapping the window.                    |
| Count       | integer     | Number of rows returned (may be capped; see has\_more). |
| Has More    | boolean     | True if more rows exist beyond the returned set.        |
| Next Offset | integer     | Pass this back as Offset to continue, if present.       |

#### Get Time Off Request

Fetch one time off request with its status, approver and reason.

**Inputs**

| Field                   | Type            | Required | Description                                                                     |
| ----------------------- | --------------- | -------- | ------------------------------------------------------------------------------- |
| Employee                | select (string) | Yes      | The employee the request belongs to. Options load from the selected connection. |
| Request ID              | integer         | Yes      | The time off request id. Minimum: 1.                                            |
| Include Daily Durations | boolean         | No       | Include the per-day duration and cost breakdown. Default: false.                |

**Outputs**

| Field   | Type | Description                                     |
| ------- | ---- | ----------------------------------------------- |
| Request | dict | The time off request with its approval details. |

#### List Employee Fields

List all employee field ids, categories and types, including custom fields.

**Inputs**

| Field              | Type    | Required | Description                                                                       |
| ------------------ | ------- | -------- | --------------------------------------------------------------------------------- |
| Category           | string  | No       | Optional category id or name to keep (e.g. 'work', 'Personal').                   |
| Custom Fields Only | boolean | No       | Only return company-defined custom fields. Default: false.                        |
| Offset             | integer | No       | Skip this many rows; pass a previous call's next\_offset. Minimum: 0. Default: 0. |
| Limit              | integer | No       | Maximum number of rows to return. Minimum: 1. Maximum: 500. Default: 100.         |

**Outputs**

| Field       | Type        | Description                                             |
| ----------- | ----------- | ------------------------------------------------------- |
| Fields      | dict\_array | The employee field definitions.                         |
| Count       | integer     | Number of rows returned (may be capped; see has\_more). |
| Has More    | boolean     | True if more rows exist beyond the returned set.        |
| Next Offset | integer     | Pass this back as Offset to continue, if present.       |

#### Get Company List

Read the items of a company list such as sites, departments or titles.

**Inputs**

| Field            | Type            | Required | Description                                                                                         |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| List             | select (string) | Yes      | The company list to read (site, department, title, ...). Options load from the selected connection. |
| Include Archived | boolean         | No       | Also return archived (no longer selectable) items. Default: false.                                  |

**Outputs**

| Field | Type        | Description                                             |
| ----- | ----------- | ------------------------------------------------------- |
| List  | string      | The list name.                                          |
| Items | dict\_array | The list items.                                         |
| Count | integer     | Number of rows returned (may be capped; see has\_more). |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/hibob.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
