HiBob API Directory

HiBob is a cutting-edge human resources management software that revolutionizes the way businesses handle HR tasks. Known as "Bob," this platform offers a comprehensive suite of features designed to streamline HR processes and enhance employee management. From onboarding workflows to time and attendance management, HiBob provides tools that simplify the complexities of HR operations. Its robust capabilities also include compensation analysis, performance reviews, and workforce planning, making it an indispensable asset for modern HR departments.

One of the standout features of HiBob is its ability to integrate seamlessly with other systems through the HiBob API. This integration capability allows businesses to connect HiBob with their existing software infrastructure, ensuring a smooth flow of data and enhancing operational efficiency. By leveraging the HiBob API, companies can customize their HR processes, automate repetitive tasks, and gain valuable insights into their workforce, ultimately driving better decision-making and fostering a more engaged and productive work environment.

Key highlights of HiBob APIs

The HiBob API offers developers a comprehensive suite of tools to integrate and automate various human resources processes within their applications. Below are the key highlights of the HiBob API:

Core Functionalities:

• Employee Management: Access and manage detailed information about employees, including personal details, employment history, and contact information. HiBob API Documentation
• Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
• Reports Generation: Generate and access various reports to gain insights into HR metrics and organizational data.
• Onboarding Integration: Integrate with Applicant Tracking Systems (ATS) to streamline the onboarding process for new hires. HiBob API Documentation

Integration Use Cases:

• Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems. HiBob API Documentation
• Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
• Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

• RESTful API: The HiBob API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

• Service User Authentication: Secure access is granted through service user credentials, which include a unique ID and token. HiBob API Documentation

Rate Limiting Policies:

• Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the HiBob API, refer to their official API documentation.

‍

HiBob API Endpoints

Attendance

• POST https://api.hibob.com/v1/attendance/import/{importMethod} : Import Attendance Data

Avatars

• PUT https://api.hibob.com/v1/avatars/{employeeId} : Upload Employee Avatar

Bulk Data

• GET https://api.hibob.com/v1/bulk/people/employment : Get Historical Employment Entries
• GET https://api.hibob.com/v1/bulk/people/lifecycle : Get Historical Lifecycle Entries for Employees
• GET https://api.hibob.com/v1/bulk/people/salaries : Get Historical Salary Entries
• GET https://api.hibob.com/v1/bulk/people/work : Get Historical Work Entries for Employees

Company

• GET https://api.hibob.com/v1/company/named-lists : Get Company Named Lists
• POST https://api.hibob.com/v1/company/named-lists/{listName} : Create a New Item in a Named List
• DELETE https://api.hibob.com/v1/company/named-lists/{listName}/{itemId} : Delete Named List Item
• GET https://api.hibob.com/v1/company/people/fields : Retrieve Employee Fields Metadata
• DELETE https://api.hibob.com/v1/company/people/fields/{fieldId} : Delete Company People Field
• GET https://api.hibob.com/v1/company/reports : Get Company Reports
• GET https://api.hibob.com/v1/company/reports/{reportId}/download : Download Company Report
• GET https://api.hibob.com/v1/company/reports/{reportId}/download-async : Asynchronously Generate and Download Report

Documents

• GET https://api.hibob.com/v1/docs/folders/metadata : Get Folder Metadata
• GET https://api.hibob.com/v1/docs/people/{id} : Get Employee Documents and Download Links
• POST https://api.hibob.com/v1/docs/people/{id}/confidential/upload : Upload File to Employee's Confidential Folder
• DELETE https://api.hibob.com/v1/docs/people/{id}/confidential/{docId} : Delete Confidential Document for Employee
• POST https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/upload : Upload File to Employee's Custom Folder
• DELETE https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/{docId} : Delete Document from Employee's Custom Folder
• POST https://api.hibob.com/v1/docs/people/{id}/shared/upload : Upload File to Employee's Shared Folder
• DELETE https://api.hibob.com/v1/docs/people/{id}/shared/{docId} : Delete Document from Employee's Shared Folder

Employees

• POST https://api.hibob.com/v1/employees/{employeeId}/invitations : Send Employee Invitation
• POST https://api.hibob.com/v1/employees/{employeeId}/start-date : Set Employee Start Date
• POST https://api.hibob.com/v1/employees/{identifier}/terminate : Terminate Employee
• POST https://api.hibob.com/v1/employees/{identifier}/uninvite : Uninvite Employee

Hiring

• POST https://api.hibob.com/v1/hiring/job-ads/search : Search Active Job Ads on Bob Career Page
• GET https://api.hibob.com/v1/hiring/job-ads/{id} : Get Job Ad Details

Metadata

• GET https://api.hibob.com/v1/metadata/objects/position : Get Position Metadata Fields

Objects

• POST https://api.hibob.com/v1/objects/position/search : Search Company Positions

Onboarding

• GET https://api.hibob.com/v1/onboarding/wizards : Get Onboarding Wizards Information

Payroll

• GET https://api.hibob.com/v1/payroll/history : Get Payroll History

People

• POST https://api.hibob.com/v1/people : Create New Employee Record in Bob
• GET https://api.hibob.com/v1/people/custom-tables/metadata : Get Custom Tables Metadata
• GET https://api.hibob.com/v1/people/custom-tables/metadata/{custom_table_id} : Get Custom Table Metadata
• POST https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id} : Create Entry in Custom Table for Employee
• DELETE https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id}/{entry_id} : Delete Custom Table Entry
• POST https://api.hibob.com/v1/people/search : Search Employees Data
• PUT https://api.hibob.com/v1/people/{identifier} : Update Employee Record in Bob
• POST https://api.hibob.com/v1/people/{id} : Update Employee Compensation Details
• GET https://api.hibob.com/v1/people/{id}/bank-accounts : Get Employee Bank Account Entries
• DELETE https://api.hibob.com/v1/people/{id}/bank-accounts/{entry_id} : Delete Employee Bank Account Entry
• GET https://api.hibob.com/v1/people/{id}/compensation : Get Employee Compensation Details
• PUT https://api.hibob.com/v1/people/{id}/email : Change Employee Email Address
• POST https://api.hibob.com/v1/people/{id}/employment : Add Employment Entry for Employee
• DELETE https://api.hibob.com/v1/people/{id}/employment/{entry_id} : Delete Employment Entry
• GET https://api.hibob.com/v1/people/{id}/equities : Get Employee Equity Grants
• DELETE https://api.hibob.com/v1/people/{id}/equities/{entry_id} : Delete Equity Entry for Employee
• GET https://api.hibob.com/v1/people/{id}/lifecycle : Get Employee Lifecycle History
• GET https://api.hibob.com/v1/people/{id}/salaries : Get Employee Salary History
• DELETE https://api.hibob.com/v1/people/{id}/salaries/{entry_id} : Delete Employee Salary Entry
• GET https://api.hibob.com/v1/people/{id}/training : Get Employee Training Records
• DELETE https://api.hibob.com/v1/people/{id}/training/{entry_id} : Delete Training Entry for Employee
• POST https://api.hibob.com/v1/people/{id}/variable : Add Variable Payment for Employee
• DELETE https://api.hibob.com/v1/people/{id}/variable/{entry_id} : Delete Variable Entry for Employee
• POST https://api.hibob.com/v1/people/{id}/work : Add Work Entry for Employee
• PUT https://api.hibob.com/v1/people/{id}/work/{entry_id} : Update Employee Work History Entry

Profiles

• GET https://api.hibob.com/v1/profiles : Get Employee Profiles

Tasks

• GET https://api.hibob.com/v1/tasks : Get All Open Tasks for Company
• GET https://api.hibob.com/v1/tasks/people/{id} : Get Employee Tasks
• POST https://api.hibob.com/v1/tasks/{taskId}/complete : Complete Task

Time Off

• POST https://api.hibob.com/v1/timeoff/employees/{id}/adjustments : Create Employee Balance Adjustment
• GET https://api.hibob.com/v1/timeoff/employees/{id}/balance : Retrieve Employee Time Off Balance
• POST https://api.hibob.com/v1/timeoff/employees/{id}/requests : Submit a New Time Off Request
• DELETE https://api.hibob.com/v1/timeoff/employees/{id}/requests/{requestId} : Cancel Time Off Request
• GET https://api.hibob.com/v1/timeoff/outtoday : Get List of People Out Today
• GET https://api.hibob.com/v1/timeoff/policies : Get Time Off Policy Details
• GET https://api.hibob.com/v1/timeoff/policies/names : Get Policy Names for Defined Policy Type
• GET https://api.hibob.com/v1/timeoff/policy-types : Get Policy Type Names
• GET https://api.hibob.com/v1/timeoff/policy-types/{policyType} : Get Policy Type Details
• POST https://api.hibob.com/v1/timeoff/policy-types/{policyType}/reason-codes : Add Reason Codes for Policy Type
• GET https://api.hibob.com/v1/timeoff/requests/changes : Get Time Off Request Changes
• GET https://api.hibob.com/v1/timeoff/whosout : Get Time Off Information for a Date Range

‍

HiBob API FAQs

How do I get started with the HiBob API?

• Answer: To begin using the HiBob API:some text
  1. Set up your account by determining your integration type (e.g., developing for your organization or becoming a Bob Partner).
  2. Obtain service user credentials for authorization.
  3. Utilize the API Reference Guide to test endpoints and develop your application efficiently.
• Source: Getting Started with Bob's API

What authentication method does the HiBob API use?

• Answer: The HiBob API uses service user credentials for authentication. You need to create a service user in Bob, which provides an ID and Token necessary for authorization. These credentials are then used in the HTTP authorization header for API requests.
• Source: API Service Users

Are there rate limits for the HiBob API?

• Answer: Yes, HiBob enforces rate limits to ensure fair usage. While specific limits are not detailed in the provided documentation, it's recommended to implement error handling for potential rate limiting responses and to consult HiBob support for detailed rate limit information.
• Source: Rate Limiting

Can I retrieve employee data using the HiBob API?

• Answer: Yes, you can retrieve employee data using the HiBob API. The /people/search endpoint allows you to access employee fields, including custom fields, based on permissions granted to the service user.
• Source: Read Employee Data

Does the HiBob API support webhooks for real-time data updates?

• Answer: Yes, HiBob supports webhooks, allowing you to subscribe to events in Bob and be notified in real-time when changes occur. This enables you to build event-driven integrations with HiBob.
• Source: Getting Started with Bob Webhooks

Get Started with HiBob API Integration

Knit API offers a convenient solution for quick and seamless integration with HiBob API. Our AI-powered integration platform allows you to build any HiBob API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to HiBob API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍