# HiBob

> HiBob (Bob) HRIS - read and manage people, time off, payroll, tasks, documents and reports.

Lets an agent read and manage your HiBob (Bob) HRIS - employees, employment
and work history, time off, tasks and onboarding, documents, payroll, company
lists, reports and custom tables.

## What it can do

| Method | What it does |
| --- | --- |
| `hibob_search_people` | Bulk search/list employees with chosen fields and filters. |
| `hibob_read_employee` | Read one employee by id or email. |
| `hibob_read_profiles` | List basic public profiles for all active employees. |
| `hibob_create_employee` | Create an employee (write). |
| `hibob_update_employee` | Update an employee's fields by category (write). |
| `hibob_update_employee_email` | Change an employee's login email (write). |
| `hibob_terminate_employee` | Terminate an employee (write). |
| `hibob_invite_employee` | Send the Bob login/welcome invite (write). |
| `hibob_uninvite_employee` | Revoke an employee's access to Bob (write). |
| `hibob_list_employment` | List an employee's employment history. |
| `hibob_create_employment` | Add an employment-history entry (write). |
| `hibob_update_employment` | Update an employment-history entry (write). |
| `hibob_delete_employment` | Delete an employment-history entry (write). |
| `hibob_list_work` | List an employee's work history (title/department/site). |
| `hibob_create_work` | Add a work-history entry, e.g. a promotion (write). |
| `hibob_update_work` | Update a work-history entry (write). |
| `hibob_delete_work` | Delete a work-history entry (write). |
| `hibob_list_lifecycle` | List an employee's lifecycle history. |
| `hibob_timeoff_balance` | Get an employee's time off balance for a policy and date. |
| `hibob_list_timeoff_requests` | List an employee's time off requests. |
| `hibob_create_timeoff_request` | Submit a time off request (write). |
| `hibob_cancel_timeoff_request` | Cancel/delete an existing time off request (write). |
| `hibob_create_timeoff_adjustment` | Adjust a time off balance (write). |
| `hibob_whos_out` | See who is out of office in a date range. |
| `hibob_list_policy_types` | List all time off policy types. |
| `hibob_get_policy` | Get a specific time off policy's details. |
| `hibob_list_tasks` | List all open tasks. |
| `hibob_list_employee_tasks` | List tasks for one employee. |
| `hibob_complete_task` | Mark a task complete (write). |
| `hibob_list_onboarding_wizards` | List onboarding wizards. |
| `hibob_list_documents` | List an employee's documents. |
| `hibob_upload_shared_document` | Attach a document (by URL) to a shared folder (write). |
| `hibob_delete_shared_document` | Delete a document from a shared folder (write). |
| `hibob_list_salaries` | List an employee's salary history. |
| `hibob_create_salary` | Add a salary entry (write). |
| `hibob_delete_salary` | Delete a salary entry (write). |
| `hibob_bulk_salaries` | Bulk read salary history across employees. |
| `hibob_list_bank_accounts` | List an employee's bank accounts. |
| `hibob_create_bank_account` | Add a bank-account entry (write). |
| `hibob_update_bank_account` | Update a bank-account entry (write). |
| `hibob_delete_bank_account` | Delete a bank-account entry (write). |
| `hibob_get_named_lists` | Get all company named lists (dropdown option sets). |
| `hibob_add_named_list_item` | Add an item to a company named list (write). |
| `hibob_get_people_fields` | Get all employee field definitions (metadata). |
| `hibob_list_reports` | List all company reports. |
| `hibob_download_report` | Download a report's data. |
| `hibob_custom_tables_metadata` | List custom-table metadata (ids and columns). |
| `hibob_list_custom_table` | List an employee's rows in a custom table. |
| `hibob_create_custom_table_entry` | Add a row to an employee's custom table (write). |
| `hibob_read_paginated` | Read one page of any pagination-enabled GET endpoint and follow `next_cursor` for large result sets. |

## How to get credentials

HiBob authenticates with a **Service User** (an ID + token pair), using HTTP
Basic auth. You must be a Bob admin.

1. In Bob, open **Settings -> Integrations -> Service users**, or follow
   [apidocs.hibob.com/docs/api-service-users](https://apidocs.hibob.com/docs/api-service-users).
2. **Create a new service user** and give it a name (e.g. *FlyMyAI Agent*).
3. Grant it the **permission groups** for the data categories you need -
   People, Time off, Payroll, Documents, Reports, and so on. The API only
   returns what this service user is allowed to see.
4. Copy the generated **service user ID** and **token** (the token is shown
   once - store it safely).
5. Combine them into one value: `<serviceUserId>:<token>`.

## Fields to fill in FlyMyAI

| FlyMyAI field | Where it comes from |
| --- | --- |
| `HIBOB_API_KEY` | `<serviceUserId>:<token>` from Settings -> Integrations -> Service users |