HiBob
API integration

list_all_hibob_people

Retrieves employee data from your HiBob account based on specified criteria. The response includes each employee's details, such as their unique identifier, name, contact information, created timestamp, updated timestamp, and employment-related information.

get_single_hibob_person_by_id

Retrieves a single employee data from your HiBob account. It always requires an ID to fetch.

hibob_people_terminate

Use this endpoint to terminate an employee in your Hibob account. You must provide the employee_id to specify which employee to terminate, and the terminationDate is required to set the effective date of termination.

update_a_hibob_person_by_id

Use this endpoint to update a single employee's data in your HiBob account. It always requires an ID to update.

hibob_people_update_email

Use this endpoint to change an employee's email address in your Hibob account. You must provide the people_id query parameter to specify which employee’s email should be updated.

create_a_hibob_person

Create a company employee in HiBob with required fields firstName, surname, and email. Returns employee details including fullName, displayName, creationDateTime, work info (startDate, manager, department, title), avatarUrl, companyId, and id.

hibob_people_revoke_access

Revoke access for an employee in HiBob using id. Returns key and error fields indicating the result of the uninvite operation.

hibob_people_invite_with_wizard

Invite an employee using employeeId and welcomeWizardId in HiBob. Returns key and error fields indicating invitation status.

hibob_people_set_start_date

Set or update an employee's start date in HiBob using employeeId and startDate. Returns the updated startDate.

list_all_hibob_time_off_requests

Use this endpoint to return time off information for users that the Service User can access within a specified date range. You must provide the from and to parameters to define the date range.

create_a_hibob_time_off_request

Use this endpoint to submit or create a new time off request for an employee in your HiBob account. You must specify an employee_id to identify the employee whose time off request details you want to create.

delete_a_hibob_time_off_request_by_id

Use this endpoint to delete an employee's existing time off request from your HiBob account. It requires an ID to delete and an employee_id to identify the employee whose time off request details you want to delete.

get_single_hibob_time_off_request_by_id

Retrieves detailed information about an employee's existing time off request from your HiBob account. It requires an ID to fetch and an employee_id to identify the employee whose time off request details you want to access.

list_all_hibob_people_lifecycle

List employee's lifecycle status history for id in HiBob. Returns fields including id, effectiveDate, status, employeeStatus, workChangeType, change details (reason, changedBy, changedById), creationDate, reasonType, isCurrent, modificationDate, leaveReason, endEffectiveDate, canBeDeleted, and customColumns.

list_all_hibob_people_work

List employee's work history by id in HiBob. Returns fields including title, department, site, reportsTo, creationDate, modificationDate, and effective dates.

list_all_hibob_people_salaries

Retrieves a list of historical salary entries from the salary table in the Payroll section for a specific employee in your HiBob account. Use the employee_id query parameter to specify the employee. The response includes key salary details such as the base salary amount and currency, pay frequency, pay period, and effective date.

list_all_hibob_policy_types

Retrieves all policy type names configured in your HiBob account. Policy types define categories such as time off, benefits, or other company-specific policies. The response provides the names of each policy type.

get_single_hibob_policy_type_by_id

Retrieves a single policy type name configured in your HiBob account. It always requires an ID to fetch.

list_all_hibob_time_off_balances

Retrieves the time-off balance for a specific employee in your HiBob account based on a particular policy type and a specified date. You must provide the employee_id to identify the employee, the policyType to specify the type of policy (e.g., vacation, sick leave), and the date to indicate the point in time for which the balance should be calculated. This allows you to view accurate balances as of a given date for tracking or reporting purposes.

create_a_hibob_time_off_balance

Create a balance adjustment for an employee in HiBob using id. Returns key and error fields indicating the adjustment result or error message.

list_all_hibob_named_lists

Get all company lists in HiBob. Returns an array of lists with fields name and items. Each item includes id, value, name, archived status, and nested children items if present.

list_all_hibob_people_fields

Get all employee fields metadata in HiBob. Returns fields with id, categoryId, categoryDisplayName, category, name, description, jsonPath, type, typeData, and historical indicating field details and category info.

create_a_hibob_people_field

Create a new people field in HiBob with required parameters name, category, and type. Returns the created field including its name, category, type, description, and historical status.

update_a_hibob_people_field_by_id

Update an existing field by id in HiBob. Returns 200 on successful update or 404 if the field does not exist.

delete_a_hibob_people_field_by_id

Delete an existing field in HiBob by fieldId. Returns success confirmation. Note: Cannot delete Bob default fields.

list_all_hibob_company_lists

Get all company lists in HiBob. Returns an array of lists with fields name and items. Each item includes id, value, name, archived status, and nested children items if present.

get_single_hibob_company_list_by_id

Get a specific company list by listName in HiBob. Returns the list name and items including id, value, name, archived status, and nested children if any.

create_a_hibob_company_list

Add a new item to an existing list in HiBob using listName. Requires name of the item and optionally parentId for hierarchy placement. Returns the id of the created list item.

update_a_hibob_company_list_by_id

Update an existing item in the named list in HiBob using list_name and id. Provide at least one of name to rename the item or parentId to move the item under a new parent node. Returns the updated item details.

delete_a_hibob_company_list_by_id

Delete an item from an existing list in HiBob. Requires list_name and id. The response confirms the deletion.

list_all_hibob_departments

Retrieves all company-defined named lists or departments in your HiBob account. These lists include predefined values used across the platform, such as departments, termination reasons, office locations, employment types, and other configurable dropdown fields.

list_all_hibob_profiles

Get a list of all active employee profiles in HiBob. Returns fields including id, firstName, surname, email, displayName, personal details (honorific, shortBirthDate, nationality, pronouns), about (avatar, hobbies, foodPreferences, socialData, superpowers), and work details (startDate, manager, tenureDuration, custom fields, durationOfEmployment).

list_all_hibob_avatar

Get avatar image URL for an employee by email in HiBob. Returns the avatar URL of the employee.

get_single_hibob_avatar_by_id

Get avatar image URL for an employee by id in HiBob. Returns the avatarUrl field containing the image URL.

hibob_avatar_upload

Upload an employee's avatar by providing the employeeId and the image URL in HiBob. Returns confirmation of successful upload.

list_all_hibob_employment_history

List employment history for employees in HiBob. Requires employeeIds parameter for specific employees. Returns employeeId and employment entries including working patterns, effectiveDate, reason, and weeklyHours.

create_a_hibob_employment_history

Create a new employment entry for an employee in HiBob. Requires id and effectiveDate. Returns fields including id, reason, effectiveDate, personalWorkingPatternType, actualWorkingPattern, standardWorkingPattern, weeklyHours, fte, calendarName, contract, type, salaryPayType, endEffectiveDate, isCurrent, modificationDate, and change details.

update_a_hibob_employment_history_by_id

Update an employment entry for employee id in HiBob. Requires id and entry_id. Returns updated employment entry including fields like effectiveDate, contract, type, salaryPayType, isCurrent, and change details.

delete_a_hibob_employment_history_by_id

Delete an employment entry from an employee's employment history in HiBob. Requires id and entry_id.

list_all_hibob_work_history

List work history entries for employees in HiBob. Returns employeeId and detailed work history including title, department, dates, reportsTo, and change info. Requires employeeIds parameter if filtering by specific employees.

create_a_hibob_work_history

Create a new work entry for an employee in HiBob using employee id. Requires effectiveDate and site or siteId. Returns confirmation of the created entry.

update_a_hibob_work_history_by_id

Update a work entry for an employee in HiBob using id and entry_id. Requires effectiveDate and either site or siteId. Returns confirmation of the updated entry.

delete_a_hibob_work_history_by_id

Delete a work entry from an employee's work history in HiBob using id and entry_id. Returns confirmation of successful deletion.

get_single_hibob_work_history_by_id

List employee's work history for id in HiBob. Returns fields including id, title, department, site, effectiveDate, endEffectiveDate, isCurrent, and reportsTo details.

list_all_hibob_lifecycle_history

List lifecycle history entries for employees in HiBob. Returns employeeId and lifecycle values including effectiveDate, status, change reason, and current status. Requires employeeIds if filtering specific employees.

list_all_hibob_payroll_history

List payroll history for employees in HiBob. Returns employeeId and salary entries including pay frequency, effective dates, base salary value and currency. Requires employeeIds parameter if filtering by employees.

create_a_hibob_payroll_history

Create a new salary entry for an employee in HiBob using id. Returns the created salary entry with fields including id, effectiveDate, payPeriod, payFrequency, isCurrent, and activeEffectiveDate. Salary entries must not conflict on effectiveDate.

delete_a_hibob_payroll_history_by_id

Delete a salary entry for an employee in HiBob using id and entry_id. Returns confirmation of successful deletion.

hibob_payroll_history_search_payment

Search actual payments by employeeId in HiBob. Returns employeeId, id, payDate, payType, amount, change, and customColumns fields. Requires filters with employeeId.

list_all_hibob_equity_grants

List the employee's equity grants by employee id in HiBob. Returns fields including id, reason, effectiveDate, quantity, equityType, vestingCommencementDate, consentNumber, grantDate, optionExpiration, exercisePrice, vestingTerm, grantType, vestingSchedule, grantNumber, and grantStatus.

create_a_hibob_equity_grant

Create a new equity grant for an employee in HiBob using employee id, effectiveDate, quantity, and equityType. Returns confirmation of the added entry.

update_a_hibob_equity_grant_by_id

Update an equity grant for an employee in HiBob using id and entry_id. Requires effectiveDate, quantity, and equityType. The entire equity entry will be overwritten. Response confirms successful update.

delete_a_hibob_equity_grant_by_id

Delete an equity grant for an employee in HiBob using employee id and entry_id. Returns confirmation of successful deletion.

list_all_hibob_variable_payment

List variable payments for an employee in HiBob. Requires employee id. Returns id, reason, effectiveDate, amount, variableType, paymentPeriod, companyPercent, departmentPercent, and individualPercent for each payment.

create_a_hibob_variable_payment

Create a new variable payment for an employee in HiBob. Requires employee id, effectiveDate, amount object, and paymentPeriod. Returns confirmation of the added entry.

delete_a_hibob_variable_payment_by_id

Delete a variable payment record for an employee in HiBob using employee id and entry_id. Returns confirmation of successful deletion.

list_all_hibob_training_records

Get the list of training records for an employee in HiBob by employee id. Returns fields including id, name, description, cost, status, frequency, startDate, endDate, documentId, and customColumns.

create_a_hibob_training_record

Create a new training record for an employee in HiBob using employee id. Returns confirmation of the added training entry.

delete_a_hibob_training_record_by_id

Delete a training record for an employee in HiBob using id and entry_id.

list_all_hibob_bank_accounts

List bank account entries for an employee in HiBob using id. Returns bankAccountType, routingNumber, accountNickname, accountNumber, bankName, branchAddress, bicOrSwift, iban, allocation, amount, useForBonus, id, and changedBy fields.

create_a_hibob_bank_account

Create a new bank account entry for an employee in HiBob using employee id. Returns confirmation of the created bank account entry.

update_a_hibob_bank_account_by_id

Update a bank account entry for an employee in HiBob using id and entry_id. Returns success status. Note: Out-of-the-box columns are overwritten; custom columns remain unless included.

delete_a_hibob_bank_account_by_id

Delete a bank account entry for an employee in HiBob using employee id and entry_id. Returns confirmation of deletion or not found status.

list_all_hibob_custom_tables

Get metadata of custom tables in HiBob. Returns tables with id, category, name, description, and columns including id, name, description, mandatory flag, type, and typeData.

get_single_hibob_custom_table_by_id

Get metadata for a specific custom table in HiBob by custom_table_id. Returns id, category, name, description, and columns with details including id, name, description, mandatory flag, type, and typeData.listId.

create_a_hibob_custom_table

Create a new custom table entry for employee_id and custom_table_id in HiBob. Provide an array of columns and their values. Returns confirmation of entry creation.

update_a_hibob_custom_table_by_id

Update custom table entry for employee_id, custom_table_id, and id in HiBob. Returns confirmation of successful update.

delete_a_hibob_custom_table_by_id

Delete a custom table entry in HiBob using employee_id, custom_table_id, and id. Returns confirmation of successful deletion.

list_all_hibob_policy_type_reason_codes

Get list of reason codes for a given policy type in HiBob. Requires policy_type. Returns id and displayName of each reason code.

create_a_hibob_policy_type_reason_code

Add a list of reason codes for a given policy type in HiBob. Requires policy_type. Returns success confirmation or 404 if policy type not found.

list_all_hibob_policy_type

Get a list of all policy type names in HiBob. Returns an array of policy type names under 'policyTypes'.

get_single_hibob_policy_type_by_id

Get details about a given policy type in HiBob using policyType name. Returns name, activity (paidTimeoff, unpaidTimeoff, workTime), bookingWorkDaysOnly (deprecated, true for new types), and unit (days, hours).

list_all_hibob_policy

Get a list of policy names for the given policyTypeName in HiBob. Returns an array of policyNames strings.

get_single_hibob_policy_by_id

Get details about a specific policy by policyName in HiBob. Returns fields including name, allowance, maxBalance, minBalance, yosIncrease (yearsOfService and extraDays), minTimeOffRequestDuration, bookingWorkDaysOnly, approvalRequired, description, and unit.

create_a_hibob_attendance

Import attendance punches using importMethod in HiBob. Requires importMethod and body with idType and requests array. Returns status, total, imported, notImported, and errors fields in response.

list_all_hibob_tasks

Get all open tasks in HiBob. Returns task id, owner details, title, requestedFor details, due date, linkInBob, set, workflow, ordinalInWorkflow, description, status, completionDate, employeeGroupId, and companyId.

get_single_hibob_task_by_id

Get tasks for a specific employee in HiBob using id. Returns fields including id, owner, title, requestedFor, due, linkInBob, set, workflow, ordinalInWorkflow, description, status, completionDate, employeeGroupId, and companyId.

hibob_tasks_mark_task_as_complete

Mark a task as complete in HiBob using id. Returns toDosUpdated indicating the number of tasks updated.

list_all_hibob_reports

Get a list of all company reports in HiBob. Returns report details including id, name, description, type, creationDate, modificationDate, createdBy, folderId, isScheduled, isComparable, and configuration. Data is filtered by user access level.

get_single_hibob_report_by_id

Download report data file by id in HiBob. Returns the report file with report name and execution date. Requires report id. Supports format, includeInfo, locale, and humanReadable query parameters.

hibob_reports_report_download_url

Get the asynchronous download URL for a report in HiBob by reportId with required format parameter. Returns the URL in the Location header for polling the generated report.

hibob_reports_download_report_by_name

Download a report by reportName in HiBob. Returns the report file including report name and execution date. If 204 is returned, the report is not ready and should be retried.

list_all_hibob_job_profiles

Read company job profiles in HiBob by providing required fields and filters. Returns job profile details including id, jobLevelRoleId, jobRoleId, jobFamilyId, jobFamilyGroupId, code, title, status, description, and assignedEmployees.

list_all_hibob_hiring

Get all active job ads from your Career page in HiBob. Requires fields array to specify which job ad fields to fetch and filters array to narrow results or fetch all active ads with empty filters. Returns job ad id, applyUrl, title, departmentId, department, employmentTypeId, employmentType, siteId, site, country, languageCode, description, requirements, responsibilities, and benefits.

get_single_hibob_hiring_by_id

Get details of a single job ad by id in HiBob. Returns job ad id, applyUrl, title, departmentId, department, employmentTypeId, employmentType, siteId, site, country, languageCode, description, requirements, responsibilities, and benefits.

list_all_hibob_job_family_group

Get all job family group fields in HiBob. Returns field id, name, description, type, and json path details.

list_all_hibob_job_family

Get all job family fields in HiBob. Returns id, name, description, fieldType (type and typeData.listId), and jsonPath (root and rawData) for each job family field.

list_all_hibob_job_family_group_library

Get all job family groups in HiBob. Returns id, name, and description fields for each job family group.

list_all_hibob_job_family_library

Get all job families in HiBob. Returns job family id, name, and description. Supports limit and cursor for pagination.

list_all_hibob_positions_fields

Get all position fields in HiBob. Returns a list of all fields of object type position.

list_all_hibob_positions_openings_fields

Get all position openings fields in HiBob. Returns a list of fields including id, name, description, and fieldType with type and typeData.

list_all_hibob_position_budget_fields

Get all position budget fields in HiBob. Returns a list of fields including id, name, description, fieldType, and typeData with jsonPath and rawData.

list_all_hibob_positions_search

Search company positions by fields and filters in HiBob. Requires fields array of field IDs and filters array of conditions. Returns position details including id, name, status, employmentType, department, site, job, and dates.

list_all_hibob_positions_openings_search

Read company positions openings filtered by specified attributes in HiBob. Requires fields and filters in the request body. Returns positionOpeningName, positionId, status, recruitmentStatus, filledBy, expectedStartDate, actualStartDate, and updateEffectiveDate.

list_all_hibob_position_budget_search

Read company positions budgets by specifying fields and filters in HiBob. Returns positionBudgetEntries including id, expectedBaseSalaryCurrencyValue, expectedVariablePayCurrencyValue, salaryPayPeriod, variablePayPeriod, Currency, totalPositionCostCurrencyValue, convertedTotalCostCurrencyValue, and updateEffectiveDate.

list_all_hibob_folders

Get list of folders with metadata in HiBob. Returns folder id, name, and folderType. Use the folder id when uploading a file to a specific folder.

list_all_hibob_employee_documents

Get list of documents for an employee in HiBob. Requires id. Returns document names and download links.

delete_a_hibob_shared_folder_by_id

Delete a specific document from a shared folder of an employee in HiBob using id and docId. Returns success status on completion.

hibob_shared_folder_upload_url_file

Upload a file from a URL to a shared folder of an employee in HiBob using id. Returns document details including id, employeeId, uploadedById, name, creationDate, status, tags, folderId, mimeType, fileId, documentName, and owner.

hibob_shared_folder_upload_file

Upload a file to a shared folder of a specific employee in HiBob using id. Returns the document id of the uploaded file.

delete_a_hibob_confidential_folder_by_id

Delete a specific document identified by docId from the confidential folder of an employee identified by id in HiBob. Returns success status on deletion.

hibob_confidential_folder_upload_url_file

Upload a file from a URL to a confidential folder for an employee in HiBob using id. Returns document details including id, employeeId, uploadedById, name, creationDate, status, tags, folderId, mimeType, fileId, documentName, and owner.

hibob_confidential_folder_upload_file

Upload a file to a confidential folder of a specific employee in HiBob. Requires employee id and file content. Returns the uploaded document's unique identifier.

delete_a_hibob_custom_folder_by_id

Delete a specific document from a custom folder of an employee in HiBob using id, folder_id, and doc_id. Returns success status on deletion.

hibob_custom_folder_upload_url_file

Upload a file from a URL to a specific custom folder of an employee in HiBob using id and folder_id. Returns document details including id, employeeId, name, creationDate, status, tags, folderId, mimeType, fileId, and owner information.

hibob_custom_folder_upload_file

Upload a file to a custom folder of a specific employee in HiBob. Requires id and folderId. Returns the uploaded document's unique identifier.

list_all_hibob_job_role_metadata

Get all job role fields in HiBob. Returns id, name, description, fieldType (type and typeData.listId), and jsonPath (root and rawData) for each job role field.

list_all_hibob_job_roles

Get all job roles in HiBob. Returns job role id, name, and description. Supports cursor-based pagination with limit and cursor parameters.