---
canonical_url: "https://docs.composio.dev/toolkits/hibob"
markdown_url: "https://docs.composio.dev/toolkits/hibob.md"
product: "platform"
version: null
last_updated: null
---

# HiBob

HiBob is a human resources platform for managing people data, attendance, time off, hiring, goals, documents, and workforce planning.

- **Category:** human resources
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 208
- **Triggers:** 0
- **Slug:** `HIBOB`
- **Version:** 00000000_00

## Tools

### Archive Project

**Slug:** `HIBOB_ARCHIVE_PROJECT`

Archive an attendance project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | integer | Yes | Project ID to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Project Task

**Slug:** `HIBOB_ARCHIVE_PROJECT_TASK`

Archive a project task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | Task ID to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive skills

**Slug:** `HIBOB_ARCHIVE_SKILLS`

Bulk-archive API-origin skills by source and externalId locator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Skills to archive. Each item must contain exact /skill/source and /skill/externalId locator keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive training content (bulk)

**Slug:** `HIBOB_ARCHIVE_TRAINING_CONTENT`

Mark one or more LMS training content items as archived.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | External identifiers of training content to archive. |
| `provider_identifier` | string | Yes | Provider identifier of the LMS integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk create attendance entries

**Slug:** `HIBOB_BULK_CREATE_ATTENDANCE_ENTRIES`

Create one or more duration or start-end attendance entries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | One to 100 attendance entries to create. |
| `request_metadata` | object | No | Optional provider request metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk update attendance entries for an employee

**Slug:** `HIBOB_BULK_UPDATE_ATTENDANCE_ENTRIES`

Update one or more attendance entries for a specific employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | One to 100 duration or start-end attendance entry updates. |
| `employeeId` | string | Yes | Employee whose entries are being updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Position

**Slug:** `HIBOB_CANCEL_POSITION`

Immediately cancel one workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `positionId` | integer | Yes | Position ID to cancel immediately. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel time off request

**Slug:** `HIBOB_CANCEL_TIME_OFF_REQUEST`

Cancel an employee's time off request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that owns the request. |
| `requestId` | integer | Yes | Time off request ID to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clock in (create entry)

**Slug:** `HIBOB_CLOCK_IN_EMPLOYEE`

Create an attendance entry by clocking in an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | No | Optional project task ID. |
| `comment` | string | No | Optional comment. |
| `entryType` | string ("work" | "break") | No | Entry type; defaults to work. |
| `projectId` | integer | No | Optional project ID. |
| `employeeId` | string | Yes | Employee ID to clock in. |
| `reasonCode` | string | No | Optional ID from the timeLogEntryReason company list. |
| `clockInTime` | string | Yes | Current-date clock-in timestamp in ISO 8601 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clock out

**Slug:** `HIBOB_CLOCK_OUT_EMPLOYEE`

Record clock-out for an employee with an open clock-in.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employeeId` | string | Yes | Employee ID to clock out. |
| `clockOutTime` | string | Yes | Current-date clock-out timestamp in ISO 8601 format; an open clock-in must exist. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark a task as complete

**Slug:** `HIBOB_COMPLETE_TASK`

Marks a task as complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | string | Yes | ID of the task to mark complete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create company employee

**Slug:** `HIBOB_CREATE_COMPANY_EMPLOYEE`

This endpoint allows you to create a new employee in the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `work` | object | Yes | Initial employment details, including site and start date. |
| `email` | string | Yes | Employee's email address. Must be a valid email address, unique within the company |
| `surname` | string | Yes | Employee's surname. Max length: 50, can only contain letters and `´`̀_-;,̩.\/'’"()`  |
| `firstName` | string | Yes | Employee's first name. Max length: 50, can only contain letters and `´`̀_-;,̩.\/'’"()`  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create new custom table entry

**Slug:** `HIBOB_CREATE_CUSTOM_TABLE_ENTRY`

Create an entry in an employee's custom table from column-value pairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `values` | array | No | Column-value objects for the new custom-table entry. |
| `employee_id` | string | Yes | Employee ID. |
| `custom_table_id` | string | Yes | The ID of custom table. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new bank account entry for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_BANK_ACCOUNT`

Create a new bank account entry for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the employee for whom you want to add the bank account entry. The employee ID is returned in the 'id' field when retrieving an employee's data.  For **testing purposes** you can obtain the Employee ID from the URL in the user interface. |
| `iban` | string | No | The international bank account number (IBAN) for international transfers. |
| `amount` | number | No | Use this field to provide the values that correspond to the ‘allocation’ field. If allocation is 'percent' this value represents the percentage of the salary portion to allocate. If allocation is 'amount' this value represents the fixed amount of the salary portion to allocate. If allocation is 'remaining' then the amount field should remain empty. This indicates that all of the remaining funds will be allocated to this account. |
| `bankName` | string | No | The name of the specific financial institution. |
| `allocation` | string ("percent" | "amount" | "remaining") | No | The salary portion allocated for this account. It can be defined as a percentage of the salary,  as a fixed amount, or to allocate all of the remaining funds. The list of possible values cannot be modified.  The values that correspond to this field should be provided in the 'amount' field. |
| `bicOrSwift` | string | No | The SWIFT Address assigned to the bank in order to send automated international transfers. |
| `useForBonus` | boolean | No | An indication whether this bank account is used for bonuses. |
| `accountNumber` | string | No | The account number is the unique identifier at this bank. |
| `branchAddress` | string | No | The bank's address. |
| `routingNumber` | string | No | The routing number indicates what bank this account is held in. Relevant for US and Canada. |
| `accountNickname` | string | No | The nickname in Bob to easily identify and personalize this account in Online Banking. |
| `bankAccountType` | string ("Checking" | "Savings") | No | The list of bank accounts type comes with the above out-of-the-box values. To obtain additional user-defined values, you should fetch the list values call the  Get all company lists Metadata API with `bankaccounttype` in the listname path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a deduction entry for an employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_DEDUCTION`

Creates a new deduction table entry for the employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `amount` | object | Yes | Deduction amount with a numeric value and three-letter currency code. |
| `endDate` | string | No | Optional explicit end date for this deduction period (ISO 8601 date). |
| `deduction` | string | Yes | Deduction type name from the company deduction type list (for example `Childcare vouchers` or `Health insurance`). To list available values, call the Get company list by name endpoint with list name `deductionType`. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `effectiveDate` | string | Yes | Start of this timeline step (ISO 8601 date). Together with `deduction`, forms a unique key per employee for each row. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a dependent entry for an employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_DEPENDENT`

Creates a new dependent entry for the employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `gender` | string | No | Dependent's gender value as stored in Bob. |
| `surname` | string | No | Dependent's surname / last name. |
| `birthDate` | string | No | Dependent's date of birth (ISO 8601 date). |
| `firstName` | string | No | Dependent's first name. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a new employment entry for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_EMPLOYMENT_HISTORY`

Creates a new employment entry for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | employee id |
| `body` | object | Yes | Employment entry to add. This must not conflict with another entry on the same effective date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an entitlement entry for an employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_ENTITLEMENT`

Creates a new entitlement table entry for the employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `amount` | object | Yes | Entitlement amount with a numeric value and three-letter currency code. |
| `endDate` | string | No | Optional explicit end date for this entitlement period (ISO 8601 date). |
| `entitlement` | string | Yes | Entitlement type name from the company entitlement type list (for example `Lunch vouchers` or `Company Car`). To list available values, call the Get company list by name endpoint with list name `entitlementType`. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `effectiveDate` | string | Yes | Start of this timeline step (ISO 8601 date). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a new equity grant for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_EQUITY_GRANT`

Creates a new equity grant for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `body` | object | Yes | Equity grant to add. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new field

**Slug:** `HIBOB_CREATE_EMPLOYEE_FIELD`

Create a new field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the field. |
| `type` | string ("text" | "text-area" | "number" | "date" | "list" | "multi-list" | "hierarchy-list" | "currency" | "employee-reference" | "document") | Yes | The type of field. Supported field types: text, text-area, number, date, list, multi-list, hierarchy-list, currency, employee-reference, document. |
| `category` | string | Yes | The category of the field. |
| `historical` | boolean | No | When true, this field keeps the history of its values, each being active starting from a certain date. The default value is false. |
| `description` | string | No | The description of the field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a right to work entry for an employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_RIGHT_TO_WORK`

Creates a new right to work entry for the employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `type` | string | No | Right to work document type (list value as stored in Bob). |
| `number` | string | No | Document or permit number. |
| `issuedBy` | string | No | Issuing authority. |
| `validFrom` | string | No | Date from which the document is valid (ISO 8601 date). |
| `documentId` | number | No | ID of the document attached to this entry. Upload files via the Docs API and reference the returned document id here. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `expirationDate` | string | No | Document expiration date (ISO 8601 date). |
| `applicationDate` | string | No | Application date (ISO 8601 date). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a new salary entry for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_SALARY_HISTORY`

Creates a new salary entry for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee backend-id. |
| `body` | object | Yes | Salary entry to add. This must not conflict with another entry on the same effective date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a new training records for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_TRAINING_RECORD`

Create a new training record in the Training table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `body` | object | Yes | Values for the Training entry you want to add. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a new variable payment for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_VARIABLE_PAYMENT`

Creates a new variable pay entry for the employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `amount` | object | Yes | Payment amount with a numeric value and three-letter currency code. |
| `reason` | string | No | The reason for this change. |
| `variableType` | string | Yes | The type of variable pay. Default values include Bonus, ExecutiveBonus, and Commission. Companies may add custom list values. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `effectiveDate` | string | Yes | The date this entry becomes effective (ISO 8601 date). |
| `paymentPeriod` | string ("Annual" | "Half-Yearly" | "Quarterly" | "Monthly") | Yes | The payment period for this variable entry. Possible values: Annual, Half-Yearly, Quarterly, Monthly. |
| `companyPercent` | number | No | The employee's company on-target weight, in percentage. |
| `departmentPercent` | number | No | The employee's department on-target weight, in percentage. |
| `individualPercent` | number | No | The employee's individual on-target weight, in percentage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new work entry for a given employee

**Slug:** `HIBOB_CREATE_EMPLOYEE_WORK_HISTORY`

Create a new work entry for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `body` | object | Yes | Work entry to add. This must not conflict with another entry on the same effective date and site. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create goals

**Slug:** `HIBOB_CREATE_GOALS`

Creates up to 25 goals in HiBob.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Up to 25 goals to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create integration

**Slug:** `HIBOB_CREATE_INTEGRATION`

Create an LMS provider integration in Bob.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `displayName` | string | No | Display name. When omitted or blank, Bob derives it from the provider identifier. |
| `providerIdentifier` | string | Yes | Stable provider key for the LMS integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create key results

**Slug:** `HIBOB_CREATE_KEY_RESULTS`

Creates up to 25 key results for an existing goal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Up to 25 key results to create. |
| `goalId` | integer | Yes | ID of the goal that will own the key results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a new item to an existing list

**Slug:** `HIBOB_CREATE_NAMED_LIST_ITEM`

Add a new item to an existing list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the item. |
| `listName` | string | Yes | The internal name of the list. |
| `parentId` | integer | No | ID of the new hierarchy parent node. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Position

**Slug:** `HIBOB_CREATE_POSITION`

Create workforce-planning positions with their required opening and optional budget.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Up to ten positions to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Position Budget

**Slug:** `HIBOB_CREATE_POSITION_BUDGET`

Create a budget for a workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | At most one position budget to create. |
| `positionId` | integer | Yes | Position ID to attach the budget to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Position Opening

**Slug:** `HIBOB_CREATE_POSITION_OPENING`

Create one or more openings for a workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Up to ten position openings to create. |
| `positionId` | integer | Yes | Position ID to add openings to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project(s)

**Slug:** `HIBOB_CREATE_PROJECTS`

Create one or more attendance projects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | One to 100 projects to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project Task(s)

**Slug:** `HIBOB_CREATE_PROJECT_TASKS`

Create one or more attendance project tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | One to 100 tasks to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create skills

**Slug:** `HIBOB_CREATE_SKILLS`

Bulk-create API-origin skills with per-item results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Skills to create. Each item uses exact documented keys including /skill/name, /skill/source, and /skill/externalId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create time off balance adjustment

**Slug:** `HIBOB_CREATE_TIME_OFF_BALANCE_ADJUSTMENT`

Add a manual balance or time-used adjustment for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID whose balance will be adjusted. |
| `amount` | number | No | Days or hours to add or subtract. |
| `reason` | string | No | Reason for the adjustment. |
| `policyType` | string | No | Policy type name. |
| `effectiveDate` | string | No | Effective date in YYYY-MM-DD format. |
| `adjustmentType` | string ("balance" | "daysUsed") | No | Adjustment type: balance or time used. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create time off reason codes

**Slug:** `HIBOB_CREATE_TIME_OFF_REASON_CODES`

Create reason codes for a configured time off policy type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyType` | string | Yes | Policy type name. |
| `reasonCodes` | array | No | Reason code display names to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create time off request

**Slug:** `HIBOB_CREATE_TIME_OFF_REQUEST`

Submit a time off request for an employee using one documented duration shape.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID receiving the time off request. |
| `body` | string | Yes | Provider-documented time off request body. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create training content (bulk insert)

**Slug:** `HIBOB_CREATE_TRAINING_CONTENT`

Create up to 500 training content items for an LMS integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Training content rows keyed by documented field paths. Each row requires non-blank `/trainingContent/externalIdentifier` and `/trainingContent/title`; supported optional keys are `/trainingContent/description`, `/trainingContent/sourceLink`, `/trainingContent/thumbnail`, `/trainingContent/duration`, `/trainingContent/language`, `/trainingContent/category`, `/trainingContent/learningGoals`, `/trainingContent/publishDate`, `/trainingContent/createdAt`, and `/trainingContent/intendedFor`. |
| `provider_identifier` | string | Yes | Provider identifier of the LMS integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an attendance entry

**Slug:** `HIBOB_DELETE_ATTENDANCE_ENTRY`

Permanently delete an attendance entry by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entryId` | integer | Yes | Attendance entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Document from a Confidential Folder

**Slug:** `HIBOB_DELETE_CONFIDENTIAL_DOCUMENT`

Delete a document from an employee's confidential folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that owns the document. |
| `docId` | string | Yes | Document ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Document from a Custom Folder

**Slug:** `HIBOB_DELETE_CUSTOM_FOLDER_DOCUMENT`

Delete a document from an employee's custom folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that owns the document. |
| `docId` | string | Yes | Document ID to delete. |
| `folderId` | string | Yes | Custom folder ID containing the document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete custom table entry

**Slug:** `HIBOB_DELETE_CUSTOM_TABLE_ENTRY`

Delete custom table entry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entry_id` | string | Yes | The ID of custom table entry. |
| `employee_id` | string | Yes | Employee ID. |
| `custom_table_id` | string | Yes | The ID of custom table. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes a bank account entry from a given employee's bank accounts table

**Slug:** `HIBOB_DELETE_EMPLOYEE_BANK_ACCOUNT`

Deletes a bank account entry from a given employee's bank accounts table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the employee for whom you want to delete the bank account entry. The employee ID is returned in the 'id' field when retrieving an employee's data.  For **testing purposes** you can obtain the Employee ID from the URL in the user interface. |
| `entry_id` | integer | Yes | The ID of the entry in the bank accounts table which you want to delete. To obtain the bank account entry use the GET /people/{id}/bank-accounts endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a deduction entry for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_DEDUCTION`

Deletes a deduction entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a dependent entry for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_DEPENDENT`

Deletes a dependent entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes an employment entry from a given employee's employment history

**Slug:** `HIBOB_DELETE_EMPLOYEE_EMPLOYMENT_HISTORY`

Deletes an employment entry from a given employee's employment history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an entitlement entry for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_ENTITLEMENT`

Deletes an entitlement entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes an equity grant for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_EQUITY_GRANT`

Deletes an equity grant for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The Entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an existing field

**Slug:** `HIBOB_DELETE_EMPLOYEE_FIELD`

Delete an existing field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fieldId` | string | Yes | The ID of the field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a right to work entry for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_RIGHT_TO_WORK`

Deletes a right to work entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes a salary entry from the employee's list

**Slug:** `HIBOB_DELETE_EMPLOYEE_SALARY_HISTORY`

Deletes a salary entry from the employee's list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes any training records for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_TRAINING_RECORD`

Deletes any training records for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The Entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes a variable payment record for an employee

**Slug:** `HIBOB_DELETE_EMPLOYEE_VARIABLE_PAYMENT`

Deletes a variable pay entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The Entry ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes a work entry from a given employee's work history

**Slug:** `HIBOB_DELETE_EMPLOYEE_WORK_HISTORY`

Deletes a work entry from a given employee's work history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `entry_id` | integer | Yes | The entry ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete goal

**Slug:** `HIBOB_DELETE_GOAL`

Permanently deletes a goal by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goalId` | integer | Yes | ID of the goal to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete key result

**Slug:** `HIBOB_DELETE_KEY_RESULT`

Permanently deletes a key result from a goal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goalId` | integer | Yes | ID of the goal containing the key result. |
| `keyResultId` | integer | Yes | ID of the key result to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete LMS integration

**Slug:** `HIBOB_DELETE_LMS_INTEGRATION`

Delete an LMS provider integration from Bob.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `provider_identifier` | string | Yes | Provider identifier of the LMS integration to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an item from an existing list

**Slug:** `HIBOB_DELETE_NAMED_LIST_ITEM`

Delete an item from an existing list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `itemId` | string | Yes | The ID of the list item. |
| `listName` | string | Yes | The internal name of the list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Position Opening

**Slug:** `HIBOB_DELETE_POSITION_OPENING`

Delete an opening from a workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `positionId` | integer | Yes | Position ID that owns the opening. |
| `positionOpeningId` | integer | Yes | Position-opening ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a Document from a Shared Folder

**Slug:** `HIBOB_DELETE_SHARED_DOCUMENT`

Delete a document from an employee's shared folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that owns the document. |
| `docId` | string | Yes | Document ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download the report by ID

**Slug:** `HIBOB_DOWNLOAD_REPORT_BY_ID`

Returns a report data file in the specified format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "xlsx" | "json") | Yes | File format. HiBob requires this query parameter; use csv for the documented default. |
| `locale` | string | No | Locale for report columns, such as fr-FR. |
| `reportId` | integer | Yes | ID of the report to download, from the company reports response. |
| `includeInfo` | boolean | No | Whether to include report information. |
| `humanReadable` | string | No | For JSON reports, APPEND or REPLACE human-readable values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download a report by the report name

**Slug:** `HIBOB_DOWNLOAD_REPORT_BY_NAME`

Downloads a report generated by the asynchronous report endpoint. A 204 response means the file is not ready and is returned as an execution failure so no empty file is emitted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reportName` | string | Yes | Report name returned in the asynchronous report Location URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read avatar URL for an employee email

**Slug:** `HIBOB_GET_AVATAR_BY_EMAIL`

Returns the employee's avatar image URL without fetching the image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the employee whose avatar URL should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read avatar URL for an employee ID

**Slug:** `HIBOB_GET_AVATAR_BY_EMPLOYEE_ID`

Returns the employee's avatar image URL without fetching the image.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employeeId` | string | Yes | The Employee ID as pulled from the database, or from the URL In Bob when viewing the employee. For example, if the URL in Bob is "https://app.hibob.com/employee-profile/3332883884017713238" you should copy the "3332883884017713238". |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read metadata for specific custom table

**Slug:** `HIBOB_GET_CUSTOM_TABLE_METADATA`

Read metadata for specific custom table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_table_id` | string | Yes | The ID of custom table. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get document folders metadata

**Slug:** `HIBOB_GET_DOCUMENT_FOLDERS_METADATA`

List Bob document folders and their identifiers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get employee time off balance

**Slug:** `HIBOB_GET_EMPLOYEE_TIME_OFF_BALANCE`

Retrieve an employee's balance for a policy type at a point in time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID whose balance will be retrieved. |
| `date` | string | Yes | Balance date in YYYY-MM-DD format. |
| `policyType` | string | Yes | Policy type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get employer metadata

**Slug:** `HIBOB_GET_EMPLOYER_METADATA`

Returns the field catalog for the `employer` object — the set of fields a client can read, with their types, validations, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Field-selection options. When omitted, the action sends an empty selection object because HiBob rejects a missing fields object. |
| `objectProperties` | array | No | Object properties to fetch. When empty, only `id` is returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get goal cycle metadata

**Slug:** `HIBOB_GET_GOAL_CYCLE_METADATA`

Returns metadata describing the fields available on goal cycles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get goals metadata

**Slug:** `HIBOB_GET_GOALS_METADATA`

Returns metadata describing the fields available on goals.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get goal type metadata

**Slug:** `HIBOB_GET_GOAL_TYPE_METADATA`

Returns metadata describing the fields available on goal types.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get job ad

**Slug:** `HIBOB_GET_JOB_AD`

Returns details of a job ad promoted on the Bob careers page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Job-ad ID from the career-page URL or the job-ad search response. |
| `preferredLanguage` | string | No | Preferred language code for translated job-ad content, when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get job family group metadata

**Slug:** `HIBOB_GET_JOB_FAMILY_GROUP_METADATA`

Returns metadata describing job-family-group fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get job family metadata

**Slug:** `HIBOB_GET_JOB_FAMILY_METADATA`

Returns metadata describing job-family fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get job profiles metadata

**Slug:** `HIBOB_GET_JOB_PROFILES_METADATA`

Returns metadata describing job-profile fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get job role metadata

**Slug:** `HIBOB_GET_JOB_ROLE_METADATA`

Returns metadata describing job-role fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get key results metadata

**Slug:** `HIBOB_GET_KEY_RESULTS_METADATA`

Returns metadata describing the fields available on key results.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a specific company list by name

**Slug:** `HIBOB_GET_NAMED_LIST`

Get a specific company list by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `listName` | string | Yes | The internal name of the list. |
| `includeArchived` | boolean | No | By default (false), archived items are excluded from the response. When set to true, archived items are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read company employee fields by employee ID

**Slug:** `HIBOB_GET_PERSON`

Single-employee read endpoint (not bulk search): returns field data for one employee identified by backend ID or email in the path in a single response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Field IDs to return in dot notation, such as root.id or work.department. Use LIST_EMPLOYEE_FIELDS to discover IDs. Omit for the default field set. Unknown or unauthorized fields are silently omitted, and response keys use slash notation such as /root/id. |
| `identifier` | string | Yes | Employee ID or email address identifying the employee to return. |
| `humanReadable` | string ("APPEND" | "REPLACE") | No | Human-readable value mode. APPEND adds human-readable values; REPLACE returns them instead of machine-format values. Omit for machine-format values only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Position Budget Metadata

**Slug:** `HIBOB_GET_POSITION_BUDGET_METADATA`

Get the field metadata for workforce-planning position budgets.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Position Metadata

**Slug:** `HIBOB_GET_POSITION_METADATA`

Get the field metadata for workforce-planning positions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Position Opening Metadata

**Slug:** `HIBOB_GET_POSITION_OPENING_METADATA`

Get the field metadata for workforce-planning position openings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Client Metadata

**Slug:** `HIBOB_GET_PROJECT_CLIENT_METADATA`

Get metadata describing available project client fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Metadata

**Slug:** `HIBOB_GET_PROJECT_METADATA`

Get metadata describing available attendance project fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project Task Metadata

**Slug:** `HIBOB_GET_PROJECT_TASK_METADATA`

Get metadata describing available project task fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get time off policy details

**Slug:** `HIBOB_GET_TIME_OFF_POLICY_DETAILS`

Retrieve details of a named time off policy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyName` | string | Yes | Policy name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get time off policy type

**Slug:** `HIBOB_GET_TIME_OFF_POLICY_TYPE`

Retrieve a configured time off policy type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyType` | string | Yes | Policy type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get time off request

**Slug:** `HIBOB_GET_TIME_OFF_REQUEST`

Retrieve one employee time off request by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that owns the request. |
| `requestId` | integer | Yes | Time off request ID. |
| `includeDailyDurations` | boolean | No | Include duration details for each day. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get work location metadata

**Slug:** `HIBOB_GET_WORK_LOCATION_METADATA`

Returns the field catalog for the `workLocation` object — the set of fields a client can read, with their types, validations, and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Field-selection options. When omitted, the action sends an empty selection object because HiBob rejects a missing fields object. |
| `objectProperties` | array | No | Object properties to fetch. When empty, only `id` is returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import attendance data

**Slug:** `HIBOB_IMPORT_ATTENDANCE_DATA`

Import employee clock-in and clock-out events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idType` | string | Yes | Employee identifier type: bobId, email, idInCompany, or a custom field path. |
| `requests` | array | Yes | Attendance events to import. |
| `importMethod` | string ("aggregate" | "immediate") | Yes | Aggregate asynchronously or insert records immediately. |
| `dateTimeFormat` | string | No | Optional custom format for event date-time values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Invite an employee with a welcome wizard ID

**Slug:** `HIBOB_INVITE_EMPLOYEE`

Invite an employee to HiBob using an onboarding welcome wizard.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employeeId` | string | Yes | Employee ID to invite. Retrieve it from an employee record or profile URL. |
| `welcomeWizardId` | integer | Yes | The Welcome wizard ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List company job profiles

**Slug:** `HIBOB_LIST_COMPANY_JOB_PROFILES`

Searches company job profiles and returns one page of matching profiles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | Yes | One to 50 standard or custom job-profile field IDs to return, such as /jobProfile/field_123. |
| `filters` | array | Yes | Job-profile filtering conditions. |
| `pagination` | object | No | Optional nested page size and continuation cursor. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values alongside raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all company lists

**Slug:** `HIBOB_LIST_COMPANY_LISTS`

Get all company lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `includeArchived` | boolean | No | By default (false), archived items are excluded from the response. When set to true, archived items are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read company reports

**Slug:** `HIBOB_LIST_COMPANY_REPORTS`

Returns a list of all company reports with their details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read all entries of the given custom table

**Slug:** `HIBOB_LIST_CUSTOM_TABLE_ENTRIES`

Read all entries of the given custom table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employeeId` | string | Yes | Employee ID. |
| `customTableId` | string | Yes | The ID of custom table. |
| `includeHumanReadable` | boolean | No | Whether to include the additional "humanReadable" JSON node in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read metadata of custom tables defined

**Slug:** `HIBOB_LIST_CUSTOM_TABLES_METADATA`

Read metadata of custom tables defined.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employee's bank accounts

**Slug:** `HIBOB_LIST_EMPLOYEE_BANK_ACCOUNTS`

Returns a list of the bank accounts table entries for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the employee for whom you want to fetch the bank account entries. The employee ID is returned in the 'id' field when retrieving an employee's data.  For **testing purposes** you can obtain the Employee ID from the URL in the user interface. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List deduction entries for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_DEDUCTION_RECORDS`

Returns deduction table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List dependents for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_DEPENDENTS_RECORDS`

Returns dependent entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download list of documents of an employee

**Slug:** `HIBOB_LIST_EMPLOYEE_DOCUMENTS`

Return an employee's documents with downloadable file references.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID whose documents should be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employee's employment history

**Slug:** `HIBOB_LIST_EMPLOYEE_EMPLOYMENT_HISTORIES`

Returns a list of employment history entries for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | employee id |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employment history for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_EMPLOYMENT_RECORDS`

Returns a list of historical employment entries from the employment table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List entitlement entries for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_ENTITLEMENT_RECORDS`

Returns entitlement table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List equity grants for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_EQUITIES_RECORDS`

Returns equity table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List the employee's equity grants

**Slug:** `HIBOB_LIST_EMPLOYEE_EQUITY_GRANTS`

Returns a list of equity grants for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all employee fields

**Slug:** `HIBOB_LIST_EMPLOYEE_FIELDS`

This endpoint retrieves only metadata about the employee fields and includes all employee fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employee's lifecycle status history

**Slug:** `HIBOB_LIST_EMPLOYEE_LIFECYCLE_HISTORIES`

Returns a list of historical lifecycle entries from the lifecycle table for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee backend-id. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List the lifecycle history for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_LIFECYCLE_RECORDS`

Returns a list of historical lifecycle entries from the lifecycle table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read the public profile section of all active employees

**Slug:** `HIBOB_LIST_EMPLOYEE_PUBLIC_PROFILES`

Returns a predefined list of fields for all active employees the service user can access.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List right to work entries for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_RIGHT_TO_WORK_RECORDS`

Returns right to work entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List payroll history (salaries) for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_SALARIES_RECORDS`

Returns a list of historical salary entries from the payroll table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employee's salary history

**Slug:** `HIBOB_LIST_EMPLOYEE_SALARY_HISTORIES`

Returns a list of historical salary entries from the salary table in the payroll section for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee backend-id. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read tasks of a specific employee

**Slug:** `HIBOB_LIST_EMPLOYEE_TASKS`

Returns tasks for a specific employee, optionally filtered by status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID whose tasks should be returned. |
| `task_status` | string ("open" | "closed") | No | Filter by open or closed status; omit to return all tasks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List the employee's training records

**Slug:** `HIBOB_LIST_EMPLOYEE_TRAINING_RECORDS`

Returns a list of training entries from the employee's Training table, for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The identifier of the employee. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employee's variable payments

**Slug:** `HIBOB_LIST_EMPLOYEE_VARIABLE_PAYMENTS`

Returns a list of variable payments for a given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List variable pay entries for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_VARIABLE_RECORDS`

Returns variable pay table entries for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the People search endpoint. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List employee's work history

**Slug:** `HIBOB_LIST_EMPLOYEE_WORK_HISTORIES`

Returns a list of historical work entries from the work table for an employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee backend-id. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List work history for a list of employees

**Slug:** `HIBOB_LIST_EMPLOYEE_WORK_RECORDS`

Returns a list of historical work entries from the work table for all employees or a specific list of employees. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Specifies the number of table entries to include on each page of the results. |
| `cursor` | string | No | A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see Pagination in Bob's API. |
| `employeeIds` | string | No | Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job families

**Slug:** `HIBOB_LIST_JOB_FAMILIES`

Returns one page of job families from the company job catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum job families to return on this page (1-100). |
| `cursor` | string | No | Cursor returned by the previous page; omit for the first page. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values alongside raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job family groups

**Slug:** `HIBOB_LIST_JOB_FAMILY_GROUPS`

Returns one page of job-family groups from the company job catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum job-family groups to return on this page (1-100). |
| `cursor` | string | No | Cursor returned by the previous page; omit for the first page. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values alongside raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List job roles

**Slug:** `HIBOB_LIST_JOB_ROLES`

Returns one page of job roles from the company job catalog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum job roles to return on this page (1-100). |
| `cursor` | string | No | Cursor returned by the previous page; omit for the first page. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values alongside raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a summary of all onboarding wizards

**Slug:** `HIBOB_LIST_ONBOARDING_WIZARDS`

List onboarding welcome wizards and their IDs for inviting employees.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List open tasks

**Slug:** `HIBOB_LIST_OPEN_TASKS`

Returns up to 5,000 open company tasks ordered by task ID. HiBob imposes this hard limit and provides no pagination, so companies with more than 5,000 open tasks receive an incomplete set.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Read payroll tables history

**Slug:** `HIBOB_LIST_PAYROLL_TABLES_HISTORY`

List legacy payroll-table history, optionally filtered by department and inactive employees; this provider endpoint is planned for deprecation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `department` | string | No | filter payroll for specific department. |
| `showInactive` | boolean | No | When `true`, includes inactive (typically terminated) employees in payroll history results. Default is active employees only. For employee field search, use `showInactive` on `POST /people/search` instead. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List people out of office

**Slug:** `HIBOB_LIST_PEOPLE_OUT_OF_OFFICE`

List people with time off requests in an inclusive date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | End date in YYYY-MM-DD format. |
| `from` | string | Yes | Start date in YYYY-MM-DD format. |
| `includeHourly` | boolean | No | Include hourly requests. |
| `includePending` | boolean | No | Include pending requests. |
| `includePrivate` | boolean | No | Include private requests; requires additional permission. |
| `includeWorkingRequests` | boolean | No | Include requests for working policy types such as work from home. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List people out today

**Slug:** `HIBOB_LIST_PEOPLE_OUT_TODAY`

List people who are out on a selected date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `today` | string | No | Date in YYYY-MM-DD format; defaults to today. |
| `siteId` | integer | No | Limit results to this site ID. |
| `includeHourly` | boolean | No | Include hourly requests. |
| `includePrivate` | boolean | No | Include private requests; requires additional permission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List proficiency levels

**Slug:** `HIBOB_LIST_PROFICIENCY_LEVELS`

Lists the company's proficiency levels referenced by skill create and update operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List time off policy names

**Slug:** `HIBOB_LIST_TIME_OFF_POLICY_NAMES`

List policy names belonging to a time off policy type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyTypeName` | string | Yes | Policy type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List time off policy types

**Slug:** `HIBOB_LIST_TIME_OFF_POLICY_TYPES`

List configured time off policy type names.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List time off reason codes

**Slug:** `HIBOB_LIST_TIME_OFF_REASON_CODES`

List request reason codes configured for a policy type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyType` | string | Yes | Policy type name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List time off request changes

**Slug:** `HIBOB_LIST_TIME_OFF_REQUEST_CHANGES`

List time off requests created, canceled, deleted, or pending since a point in time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Optional end timestamp or date for the changes window. |
| `since` | string | Yes | Start timestamp or date for the changes window. |
| `includePending` | boolean | No | Include pending requests. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Project

**Slug:** `HIBOB_RESTORE_PROJECT`

Restore an archived attendance project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | integer | Yes | Project ID to restore. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Project Task

**Slug:** `HIBOB_RESTORE_PROJECT_TASK`

Restore an archived project task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | Task ID to restore. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke access to Bob for an employee

**Slug:** `HIBOB_REVOKE_EMPLOYEE_ACCESS`

Revoke an employee's access to HiBob without deleting the employee record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifier` | string | Yes | Employee ID whose access to HiBob will be revoked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Schedule Position Cancellation

**Slug:** `HIBOB_SCHEDULE_POSITION_CANCELLATION`

Cancel multiple positions immediately or on a specified date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `positionIds` | array | Yes | Position IDs to cancel. |
| `cancellationDate` | string | No | Cancellation date in YYYY-MM-DD format; omit to cancel immediately. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search for actual payments

**Slug:** `HIBOB_SEARCH_ACTUAL_PAYMENTS`

This endpoint allows you to search for actual payments based on various filters. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `filters` | array | Yes | An array of filter criteria, each containing a field ID, operator, and values. Supported fields for filtering are:  `employeeId` (required): Filter by the the employee ID. All queries must specify the employee Ids to fetch. Each call can retrieve up to 200 employees. `payDate` (optional): Filter by the date of the pay period.  Important: The array must include a filter for employeeId, as it is required for all requests. The structure of the filters may vary slightly depending on the field being used. |
| `pagination` | object | No | Optional pagination parameters. |
| `includeArchived` | boolean | No | By default (false), archived columns are excluded from the response. When set to true, archived columns are included. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search application form answers

**Slug:** `HIBOB_SEARCH_APPLICATION_FORM_ANSWERS`

Searches application form answer records using filters and returns one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records to return on this page (1-200). |
| `cursor` | string | No | Continuation cursor from the previous page; omit for the first page. |
| `fields` | array | Yes | Field IDs to return, chosen from the documented /applicationFormAnswer fields. |
| `filters` | array | No | Filters to apply to application form answers. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search applications

**Slug:** `HIBOB_SEARCH_APPLICATIONS`

Searches applications using filters and returns one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records to return on this page (1-200). |
| `cursor` | string | No | Continuation cursor from the previous page; omit for the first page. |
| `fields` | array | Yes | Field IDs to return, chosen from the documented /application fields. |
| `filters` | array | No | Filters to apply to applications. |
| `includeArchived` | boolean | No | Whether to include archived applications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch attendance entries

**Slug:** `HIBOB_SEARCH_ATTENDANCE_ENTRIES`

Retrieve one page of attendance entries for employees and dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items per page. |
| `cursor` | string | No | Continuation cursor from the previous page. |
| `fields` | array | Yes | Attendance entry field IDs to return. |
| `filters` | array | Yes | Employee ID and clock-in date filters. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch attendance summaries

**Slug:** `HIBOB_SEARCH_ATTENDANCE_SUMMARIES`

Retrieve one page of attendance summaries by employee and date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items per page. |
| `cursor` | string | No | Continuation cursor from the previous page. |
| `fields` | array | Yes | Required summary field IDs to return; include /attendanceSummary/employeeId. |
| `filters` | array | Yes | Exactly dateRange and employeeId filters. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values; currently unsupported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search calendar events

**Slug:** `HIBOB_SEARCH_CALENDAR_EVENTS`

Search holiday and company-closure calendar events for an inclusive date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size (1-500). |
| `cursor` | string | No | Cursor from the previous page. |
| `fields` | array | No | Calendar-event field IDs to return; omit for all fields. |
| `filters` | array | Yes | Filters including startDate from/to filters spanning at most 366 days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate educations

**Slug:** `HIBOB_SEARCH_CANDIDATE_EDUCATIONS`

Searches candidate education records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateEducation field IDs to return. |
| `filters` | array | No | Filters to apply to education records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate experiences

**Slug:** `HIBOB_SEARCH_CANDIDATE_EXPERIENCES`

Searches candidate work experience records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateExperience field IDs to return. |
| `filters` | array | No | Filters to apply to experience records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate languages

**Slug:** `HIBOB_SEARCH_CANDIDATE_LANGUAGES`

Searches candidate language records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateLanguage field IDs to return. |
| `filters` | array | No | Filters to apply to language records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate professional association memberships

**Slug:** `HIBOB_SEARCH_CANDIDATE_PROFESSIONAL_ASSOCIATIONS_MEMBERSHIPS`

Searches candidate professional association membership records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateProfessionalAssociationsMemberships field IDs to return. |
| `filters` | array | No | Filters to apply to membership records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate qualifications and licenses

**Slug:** `HIBOB_SEARCH_CANDIDATE_QUALIFICATIONS_LICENSES`

Searches candidate qualification and license records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateQualificationsLicenses field IDs to return. |
| `filters` | array | No | Filters to apply to qualification and license records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidates

**Slug:** `HIBOB_SEARCH_CANDIDATES`

Searches candidates using filters and returns one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum candidates on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidate field IDs to return. |
| `filters` | array | No | Filters to apply to candidates. |
| `includeArchived` | boolean | No | Whether to include archived candidates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate skills

**Slug:** `HIBOB_SEARCH_CANDIDATE_SKILLS`

Searches candidate skill records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateSkills field IDs to return. |
| `filters` | array | No | Filters to apply to skill records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search candidate volunteer experiences

**Slug:** `HIBOB_SEARCH_CANDIDATE_VOLUNTEER_EXPERIENCES`

Searches candidate volunteer experience records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum records on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /candidateVolunteerExperience field IDs to return. |
| `filters` | array | No | Filters to apply to volunteer experience records. |
| `includeArchived` | boolean | No | Whether to include archived records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch daily attendance breakdown

**Slug:** `HIBOB_SEARCH_DAILY_ATTENDANCE_BREAKDOWN`

Retrieve one page of daily attendance breakdown data for employees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum items per page. |
| `cursor` | string | No | Continuation cursor from the previous page. |
| `fields` | array | Yes | Required field IDs to return; include /dailyBreakdown/employeeId and /dailyBreakdown/date. Custom field IDs are supported. |
| `filters` | array | Yes | Exactly three filters: date from, date to, and employeeId equals. |
| `includeHumanReadable` | boolean | No | Whether to include human-readable values; currently unsupported. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search employee calendars

**Slug:** `HIBOB_SEARCH_EMPLOYEE_CALENDARS`

Resolve holiday calendars for employees and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size (1-1000). |
| `cursor` | string | No | Cursor from the previous page. |
| `fields` | array | No | Employee-calendar field IDs to return; omit for all fields. |
| `filters` | array | Yes | Filters, including exactly one employeeId filter with at most 5000 IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search employers

**Slug:** `HIBOB_SEARCH_EMPLOYERS`

Searches employers in the caller's company. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items per page (allowed range 1–200). Defaults to 50. |
| `cursor` | string | No | Opaque cursor from a previous response's `response_metadata.next_cursor`. Omit on the first request. |
| `fields` | array | No | Field IDs to include in each result item. When omitted, all available fields are returned. Discover the authoritative field catalog (including custom fields) via the employer metadata search endpoint; out-of-the-box field IDs are also listed as keys on the `Employer` response schema. |
| `filters` | array | Yes | Filters to apply. An empty list returns every employer the caller has permission to view. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search evaluations

**Slug:** `HIBOB_SEARCH_EVALUATIONS`

Searches evaluation records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum evaluations on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /evaluation field IDs to return. |
| `filters` | array | No | Filters to apply to evaluations. |
| `includeArchived` | boolean | No | Whether to include archived evaluations. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search evaluation scorecard templates

**Slug:** `HIBOB_SEARCH_EVALUATION_SCORECARD_TEMPLATES`

Searches evaluation scorecard templates and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum templates on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /evaluationScorecardTemplate field IDs to return. |
| `filters` | array | No | Filters to apply to scorecard templates. |
| `includeArchived` | boolean | No | Whether to include archived templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search goal cycles

**Slug:** `HIBOB_SEARCH_GOAL_CYCLES`

Searches goal cycles and returns one page of matching records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of items to return on this page. |
| `cursor` | string | No | Cursor returned by the previous page; omit for the first page. |
| `fields` | array | Yes | Field IDs to include. Use goal-cycle metadata to discover valid IDs. |
| `filters` | array | No | Filters; currently must be empty or omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search goals

**Slug:** `HIBOB_SEARCH_GOALS`

Searches goals and returns one page of matching records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum results requested; currently accepted but not enforced by HiBob. |
| `cursor` | string | No | Cursor returned by the previous page; currently accepted but not enforced by HiBob. |
| `fields` | array | Yes | Field IDs to include. Use goal metadata to discover valid IDs. |
| `filters` | array | No | Filters to apply; omit or use an empty list for all goals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search goal types

**Slug:** `HIBOB_SEARCH_GOAL_TYPES`

Searches goal types and returns one page of matching records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum results requested; currently accepted but not enforced by HiBob. |
| `cursor` | string | No | Cursor returned by the previous page; currently accepted but not enforced by HiBob. |
| `fields` | array | Yes | Field IDs to include. Use goal-type metadata to discover valid IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search interviews

**Slug:** `HIBOB_SEARCH_INTERVIEWS`

Searches interview records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum interviews on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /interview field IDs to return. |
| `filters` | array | No | Filters to apply to interviews. |
| `includeArchived` | boolean | No | Whether to include archived interviews. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search job ads

**Slug:** `HIBOB_SEARCH_JOB_ADS`

Returns active job ads promoted on the Bob career page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | Yes | Documented /jobAd field IDs to return for each active job ad. |
| `filters` | array | Yes | Required filters array for active job ads; use an empty list to return all active ads. |
| `preferredLanguage` | string | No | Preferred language code for translated job-ad content, when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search job openings

**Slug:** `HIBOB_SEARCH_JOB_OPENINGS`

Searches job openings using filters and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum job openings on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /jobOpening field IDs to return. |
| `filters` | array | No | Filters to apply to job openings. |
| `includeArchived` | boolean | No | Whether to include archived job openings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search key results

**Slug:** `HIBOB_SEARCH_KEY_RESULTS`

Searches key results for a goal and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum results requested; currently accepted but not enforced by HiBob. |
| `cursor` | string | No | Cursor returned by the previous page; currently accepted but not enforced by HiBob. |
| `fields` | array | Yes | Field IDs to include. Use key-result metadata to discover valid IDs. |
| `filters` | array | Yes | Filters to apply; a goalId filter is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search offers

**Slug:** `HIBOB_SEARCH_OFFERS`

Searches offer records and returns one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum offers on this page (1-200). |
| `cursor` | string | No | Continuation cursor; omit for the first page. |
| `fields` | array | Yes | Documented /offer field IDs to return. |
| `filters` | array | No | Filters to apply to offers. |
| `includeArchived` | boolean | No | Whether to include archived offers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search for employees

**Slug:** `HIBOB_SEARCH_PEOPLE`

Search employee fields for many employees in one call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Field IDs to return in dot notation, such as root.id. Use LIST_EMPLOYEE_FIELDS to discover IDs. Omit for the default field set; at most 400 are accepted. |
| `filters` | array | No | Optional single filter on root.id or root.email using the equals operator. Omit when not filtering. |
| `showInactive` | boolean | No | Whether to include inactive, typically terminated or former, employees. Defaults to false for active employees only. |
| `humanReadable` | string ("APPEND" | "REPLACE") | No | Human-readable value mode. APPEND adds human-readable values; REPLACE returns them instead of machine-format values. Omit for machine-format values only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Position Budgets

**Slug:** `HIBOB_SEARCH_POSITION_BUDGETS`

Return one page of workforce-planning position budgets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from the preceding page; omit for the first page. |
| `fields` | array | Yes | Position-budget field IDs to return. |
| `filters` | array | Yes | Budget filtering conditions. |
| `pagination` | object | No | Nested HiBob pagination options. |
| `includeHumanReadable` | boolean | No | Include human-readable values with raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Position Openings

**Slug:** `HIBOB_SEARCH_POSITION_OPENINGS`

Return one page of workforce-planning position openings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor from the preceding page; omit for the first page. |
| `fields` | array | Yes | Position-opening field IDs to return. |
| `filters` | array | Yes | Opening filtering conditions. |
| `pagination` | object | No | Nested HiBob pagination options. |
| `includeHumanReadable` | boolean | No | Include human-readable values with raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Positions

**Slug:** `HIBOB_SEARCH_POSITIONS`

Search workforce-planning positions using documented field filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | Yes | Position field IDs to return; use metadata to discover custom IDs. |
| `filters` | array | Yes | Position filtering conditions. |
| `includeHumanReadable` | boolean | No | Include human-readable values with raw values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Project Clients

**Slug:** `HIBOB_SEARCH_PROJECT_CLIENTS`

Search project clients and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Requested page size; currently ignored. |
| `cursor` | string | No | Continuation cursor; currently ignored by HiBob. |
| `fields` | array | No | Project client field IDs to return. |
| `filters` | array | No | Optional project client filters. |
| `includeHumanReadable` | boolean | No | Include human-readable field values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Projects

**Slug:** `HIBOB_SEARCH_PROJECTS`

Search attendance projects and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Requested page size; currently ignored. |
| `cursor` | string | No | Continuation cursor; currently ignored by HiBob. |
| `fields` | array | No | Project field IDs to return; custom field IDs are supported. |
| `filters` | array | No | Project filters. |
| `includeHumanReadable` | boolean | No | Include human-readable field values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Project Tasks

**Slug:** `HIBOB_SEARCH_PROJECT_TASKS`

Search attendance project tasks and return one page of results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Requested page size; currently ignored. |
| `cursor` | string | No | Continuation cursor; currently ignored by HiBob. |
| `fields` | array | No | Task field IDs to return. |
| `filters` | array | No | Optional task filters. |
| `includeHumanReadable` | boolean | No | Include human-readable field values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search skills

**Slug:** `HIBOB_SEARCH_SKILLS`

Searches API-origin skills with field projection, filters, and one-page cursor pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum results on this page (1-200). |
| `cursor` | string | No | Opaque continuation cursor; omit for the first page. |
| `fields` | array | No | Field IDs to include; empty returns the default field set. |
| `filters` | array | No | Equals filters; empty returns all API-origin skills. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search work locations

**Slug:** `HIBOB_SEARCH_WORK_LOCATIONS`

Searches the work locations of a single employer, identified by the path parameter `{employerId}`. Returns one page and a continuation cursor when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of items per page (allowed range 1–200). Defaults to 50. |
| `cursor` | string | No | Opaque cursor from a previous response's `response_metadata.next_cursor`. Omit on the first request. |
| `fields` | array | No | Field IDs to include in each result item. When omitted, all available fields are returned. Discover the authoritative field catalog (including custom fields) via the work-location metadata search endpoint; out-of-the-box field IDs are also listed as keys on the `WorkLocation` response schema. |
| `filters` | array | Yes | Filters to apply within the employer's work locations. An empty list returns every work location of the employer the caller has permission to view. |
| `employerId` | string | Yes | Identifier of the parent employer whose work locations to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set or update an employee's start date

**Slug:** `HIBOB_SET_EMPLOYEE_START_DATE`

Set or change an employee's employment start date, with an optional reason.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Additional info for the start date update. |
| `startDate` | string | Yes | The date this entry becomes effective. |
| `employeeId` | string | Yes | Employee ID whose employment start date will be set or changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the report download URL for polling

**Slug:** `HIBOB_START_REPORT_GENERATION`

Asynchronously generates a report. HiBob returns 202 while generation starts and 200 with the generated report URL in the Location response header.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("csv" | "xlsx") | Yes | File format to generate. HiBob requires this query parameter; use csv for the documented default. |
| `locale` | string | No | Locale for report columns, such as fr-FR. |
| `reportId` | integer | Yes | ID of the report to generate, from the company reports response. |
| `includeInfo` | boolean | No | Whether to include report information. |
| `humanReadable` | string | No | Human-readable value mode when supported by HiBob. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit xAPI statement

**Slug:** `HIBOB_SUBMIT_X_API_STATEMENT`

Submit one xAPI statement to record learner progress for a course.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Optional statement UUID. |
| `verb` | object | Yes | Action performed by the learner. |
| `actor` | object | Yes | Learner who performed the activity. |
| `object` | object | Yes | Learning activity acted upon. |
| `result` | object | No | Optional activity result. |
| `timestamp` | string | Yes | Statement timestamp in an ISO format accepted by Bob. |
| `provider_identifier` | string | Yes | Provider identifier of the LMS integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Terminate company employee

**Slug:** `HIBOB_TERMINATE_COMPANY_EMPLOYEE`

This changes the employee’s status to Terminated according to specified termination date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifier` | string | Yes | Employee ID to terminate. |
| `reasonType` | string | No | The ID of the 'lifecycleReasonType' list entry |
| `noticePeriod` | object | No | Notice period length |
| `lastDayOfWork` | string | No | Employee's final working date, when different from the termination date. |
| `terminationDate` | string | Yes | The employee's termination date |
| `terminationReason` | string | No | The ID of the 'terminationReason' list entry |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update company employee

**Slug:** `HIBOB_UPDATE_COMPANY_EMPLOYEE`

This endpoint allows you to update specific fields in an employee's record in Bob.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | Employee field values to update. Use LIST_EMPLOYEE_FIELDS to discover available field definitions. |
| `identifier` | string | Yes | Employee ID whose record will be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update custom table entry

**Slug:** `HIBOB_UPDATE_CUSTOM_TABLE_ENTRY`

Update an employee's custom-table entry from column-value pairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | The documented JSON request body. |
| `entry_id` | string | Yes | The ID of custom table entry. |
| `employee_id` | string | Yes | Employee ID. |
| `custom_table_id` | string | Yes | The ID of custom table. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload employee's avatar by image url

**Slug:** `HIBOB_UPDATE_EMPLOYEE_AVATAR`

Upload an employee's Avatar by providing a URL to the image to upload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the source of the avatar image. |
| `employeeId` | string | Yes | Employee ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a bank account entry in the employee's bank accounts table

**Slug:** `HIBOB_UPDATE_EMPLOYEE_BANK_ACCOUNT`

This endpoint updates an entry in the employee’s Bank accounts table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the employee for whom you want to update the bank account entry. The employee ID is returned in the 'id' field when retrieving an employee's data.  For **testing purposes** you can obtain the Employee ID from the URL in the user interface. |
| `iban` | string | No | The international bank account number (IBAN) for international transfers. |
| `amount` | number | No | Use this field to provide the values that correspond to the ‘allocation’ field. If allocation is 'percent' this value represents the percentage of the salary portion to allocate. If allocation is 'amount' this value represents the fixed amount of the salary portion to allocate. If allocation is 'remaining' then the amount field should remain empty. This indicates that all of the remaining funds will be allocated to this account. |
| `entryId` | integer | Yes | The ID of the entry in the bank accounts table which you are updating. To obtain the bank account entry use the GET /people/{id}/bank-accounts endpoint. |
| `bankName` | string | No | The name of the specific financial institution. |
| `allocation` | string ("percent" | "amount" | "remaining") | No | The salary portion allocated for this account. It can be defined as a percentage of the salary,  as a fixed amount, or to allocate all of the remaining funds. The list of possible values cannot be modified.  The values that correspond to this field should be provided in the 'amount' field. |
| `bicOrSwift` | string | No | The SWIFT Address assigned to the bank in order to send automated international transfers. |
| `useForBonus` | boolean | No | An indication whether this bank account is used for bonuses. |
| `accountNumber` | string | No | The account number is the unique identifier at this bank. |
| `branchAddress` | string | No | The bank's address. |
| `routingNumber` | string | No | The routing number indicates what bank this account is held in. Relevant for US and Canada. |
| `accountNickname` | string | No | The nickname in Bob to easily identify and personalize this account in Online Banking. |
| `bankAccountType` | string ("Checking" | "Savings") | No | The list of bank accounts type comes with the above out-of-the-box values. To obtain additional user-defined values, you should fetch the list values call the  Get all company lists Metadata API with `bankaccounttype` in the listname path parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a deduction entry for an employee

**Slug:** `HIBOB_UPDATE_EMPLOYEE_DEDUCTION`

Updates an existing deduction entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `amount` | object | Yes | Deduction amount with a numeric value and three-letter currency code. |
| `endDate` | string | No | Optional explicit end date for this deduction period (ISO 8601 date). |
| `entryId` | integer | Yes | The entry ID to update. |
| `deduction` | string | Yes | Deduction type name from the company deduction type list (for example `Childcare vouchers` or `Health insurance`). To list available values, call the Get company list by name endpoint with list name `deductionType`. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `effectiveDate` | string | Yes | Start of this timeline step (ISO 8601 date). Together with `deduction`, forms a unique key per employee for each row. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a dependent entry for an employee

**Slug:** `HIBOB_UPDATE_EMPLOYEE_DEPENDENT`

Updates an existing dependent entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `body` | object | Yes | Values for the dependent entry you want to update. |
| `entry_id` | integer | Yes | The entry ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an employee's email address

**Slug:** `HIBOB_UPDATE_EMPLOYEE_EMAIL`

Change an employee's email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | employee id |
| `email` | string | No | new email |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an employment entry from a given employee's employment history

**Slug:** `HIBOB_UPDATE_EMPLOYEE_EMPLOYMENT_HISTORY`

This endpoint updates an entry in the employee’s employment history table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `body` | object | Yes | The documented JSON request body. |
| `entry_id` | integer | Yes | The entry ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an entitlement entry for an employee

**Slug:** `HIBOB_UPDATE_EMPLOYEE_ENTITLEMENT`

Updates an existing entitlement entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `amount` | object | Yes | Entitlement amount with a numeric value and three-letter currency code. |
| `endDate` | string | No | Optional explicit end date for this entitlement period (ISO 8601 date). |
| `entryId` | integer | Yes | The entry ID to update. |
| `entitlement` | string | Yes | Entitlement type name from the company entitlement type list (for example `Lunch vouchers` or `Company Car`). To list available values, call the Get company list by name endpoint with list name `entitlementType`. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `effectiveDate` | string | Yes | Start of this timeline step (ISO 8601 date). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Updates an equity grant for an employee

**Slug:** `HIBOB_UPDATE_EMPLOYEE_EQUITY_GRANT`

This endpoint updates an entry in the employee’s equity table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID |
| `body` | object | Yes | The documented JSON request body. |
| `entry_id` | integer | Yes | The entry ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an existing field

**Slug:** `HIBOB_UPDATE_EMPLOYEE_FIELD`

Update an existing field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the field. |
| `fieldId` | string | Yes | The ID of the field. |
| `description` | string | No | The description of the field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a right to work entry for an employee

**Slug:** `HIBOB_UPDATE_EMPLOYEE_RIGHT_TO_WORK`

Updates an existing right to work entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `body` | object | Yes | Values for the right to work entry you want to update. |
| `entry_id` | integer | Yes | The entry ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a variable payment for an employee

**Slug:** `HIBOB_UPDATE_EMPLOYEE_VARIABLE_PAYMENT`

Updates an existing variable pay entry for the given employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID. |
| `amount` | object | Yes | Payment amount with a numeric value and three-letter currency code. |
| `reason` | string | No | The reason for this change. |
| `entryId` | integer | Yes | The entry ID to update. |
| `variableType` | string | Yes | The type of variable pay. Default values include Bonus, ExecutiveBonus, and Commission. Companies may add custom list values. |
| `customColumns` | object | No | Custom column values for this entry, keyed by column id. |
| `effectiveDate` | string | Yes | The date this entry becomes effective (ISO 8601 date). |
| `paymentPeriod` | string ("Annual" | "Half-Yearly" | "Quarterly" | "Monthly") | Yes | The payment period for this variable entry. Possible values: Annual, Half-Yearly, Quarterly, Monthly. |
| `companyPercent` | number | No | The employee's company on-target weight, in percentage. |
| `departmentPercent` | number | No | The employee's department on-target weight, in percentage. |
| `individualPercent` | number | No | The employee's individual on-target weight, in percentage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a work entry in the employee's work history table

**Slug:** `HIBOB_UPDATE_EMPLOYEE_WORK_HISTORY`

This endpoint updates an entry in the employee’s work history table.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the employee you are updating. This can be the Employee ID from the URL in the user interface or the id field returned when retrieving an employee's data. |
| `body` | object | Yes | The documented JSON request body. |
| `entry_id` | integer | Yes | The ID of the entry in the work table which you are updating. To obtain the work entry use the GET /people/{id}/work endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update goal

**Slug:** `HIBOB_UPDATE_GOAL`

Updates details of an existing goal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Single goal update item. |
| `goalId` | integer | Yes | ID of the goal to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update goal status

**Slug:** `HIBOB_UPDATE_GOAL_STATUS`

Updates the status of an existing goal and optionally records a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goalId` | integer | Yes | ID of the goal whose status will change. |
| `status` | string ("onTrack" | "offTrack" | "completed" | "incomplete" | "other") | Yes | New goal status. |
| `comment` | string | No | Optional comment for the status update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update key results details

**Slug:** `HIBOB_UPDATE_KEY_RESULTS_DETAILS`

Updates details of one or more key results on a goal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Key results to update. |
| `goalId` | integer | Yes | ID of the goal containing the key results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update key results progress

**Slug:** `HIBOB_UPDATE_KEY_RESULTS_PROGRESS`

Records progress values and optional check-in notes for key results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goalId` | integer | Yes | ID of the goal containing the key results. |
| `comment` | string | No | Optional goal-level check-in comment stored in the activity log. |
| `keyResults` | array | No | Key-result progress updates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an existing item from a list

**Slug:** `HIBOB_UPDATE_NAMED_LIST_ITEM`

Update an existing item from a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the item. |
| `itemId` | string | Yes | The ID of the list item. |
| `listName` | string | Yes | The internal name of the list. |
| `parentId` | integer | No | ID of the new hierarchy parent node. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Position

**Slug:** `HIBOB_UPDATE_POSITION`

Update the mutable fields of one workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | At most one position update item. |
| `positionId` | integer | Yes | Position ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Position Budget

**Slug:** `HIBOB_UPDATE_POSITION_BUDGET`

Update a budget attached to a workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | At most one position-budget update item. |
| `positionId` | integer | Yes | Position ID that owns the budget. |
| `positionBudgetId` | integer | Yes | Position-budget ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Position Opening

**Slug:** `HIBOB_UPDATE_POSITION_OPENING`

Update an opening attached to a workforce-planning position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | At most one position-opening update item. |
| `positionId` | integer | Yes | Position ID that owns the opening. |
| `positionOpeningId` | integer | Yes | Position-opening ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `HIBOB_UPDATE_PROJECT`

Update an attendance project's fields and employee audience.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Exactly one project update. |
| `projectId` | integer | Yes | Project ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project Task

**Slug:** `HIBOB_UPDATE_PROJECT_TASK`

Update the name and billable state of a project task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Exactly one task update. |
| `taskId` | integer | Yes | Task ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update skills

**Slug:** `HIBOB_UPDATE_SKILLS`

Bulk-update API-origin skills resolved by source and externalId locator.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Skills to update. Each item uses exact /skill/source and /skill/externalId locator keys and optional documented /skill/* update keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update training content (bulk patch)

**Slug:** `HIBOB_UPDATE_TRAINING_CONTENT`

Update one or more training content items for an LMS integration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Training content rows keyed by documented field paths such as `/trainingContent/externalIdentifier`, `/trainingContent/title`, `/trainingContent/description`, `/trainingContent/sourceLink`, `/trainingContent/thumbnail`, `/trainingContent/duration`, `/trainingContent/language`, `/trainingContent/category`, `/trainingContent/learningGoals`, `/trainingContent/publishDate`, `/trainingContent/createdAt`, and `/trainingContent/intendedFor`. |
| `provider_identifier` | string | Yes | Provider identifier of the LMS integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File to a Confidential Folder

**Slug:** `HIBOB_UPLOAD_CONFIDENTIAL_DOCUMENT`

Upload a file directly into an employee's confidential folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that will own the document. |
| `file` | object | Yes | File to upload to the confidential folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload file from a URL to a Confidential Folder

**Slug:** `HIBOB_UPLOAD_CONFIDENTIAL_DOCUMENT_FROM_URL`

Upload a document from a URL into an employee's confidential folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that will own the document. |
| `tags` | array | No | Tags to attach to the document in Bob. |
| `documentUrl` | string | No | URL from which Bob should fetch the document. |
| `documentName` | string | No | Document name in Bob. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File to a Custom Folder

**Slug:** `HIBOB_UPLOAD_CUSTOM_FOLDER_DOCUMENT`

Upload a file directly into an employee's custom folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that will own the document. |
| `file` | object | Yes | File to upload to the custom folder. |
| `folderId` | string | Yes | Custom folder ID for the upload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File from a URL to a Custom Folder

**Slug:** `HIBOB_UPLOAD_CUSTOM_FOLDER_DOCUMENT_FROM_URL`

Upload a document from a URL into an employee's custom folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that will own the document. |
| `tags` | array | No | Tags to attach to the document in Bob. |
| `folderId` | string | Yes | Custom folder ID for the upload. |
| `documentUrl` | string | No | URL from which Bob should fetch the document. |
| `documentName` | string | No | Document name in Bob. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload file to a Shared Folder

**Slug:** `HIBOB_UPLOAD_SHARED_DOCUMENT`

Upload a file directly into an employee's shared folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that will own the document. |
| `file` | object | Yes | File to upload to the shared folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload file from a URL to a Shared Folder

**Slug:** `HIBOB_UPLOAD_SHARED_DOCUMENT_FROM_URL`

Upload a document from a URL into an employee's shared folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Employee ID that will own the document. |
| `tags` | array | No | Tags to attach to the document in Bob. |
| `documentUrl` | string | No | URL from which Bob should fetch the document. |
| `documentName` | string | No | Document name in Bob. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |