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} : The Import Attendance Data API allows you to import attendance records for employees.

Avatars

PUT https://api.hibob.com/v1/avatars/{employeeId} : This API endpoint allows you to upload an employee's avatar by providing a URL to the image.

Bulk People

GET https://api.hibob.com/v1/bulk/people/employment : This API endpoint retrieves a list of historical employment entries from the employment table for all employees or a specific list of employees.
GET https://api.hibob.com/v1/bulk/people/lifecycle : This API endpoint retrieves a list of historical lifecycle entries from the lifecycle table for all employees or a specified list of employees.
GET https://api.hibob.com/v1/bulk/people/salaries : This API endpoint retrieves a list of historical salary entries from the payroll table for all employees or a specified list of employees.
GET https://api.hibob.com/v1/bulk/people/work : This API endpoint retrieves a list of historical work entries from the work table for all employees or a specific list of employees.

Company

GET https://api.hibob.com/v1/company/named-lists : The Get Company Named Lists API retrieves named lists from the company database.
POST https://api.hibob.com/v1/company/named-lists/{listName} : This API endpoint allows you to create a new item in a named list within the company.
DELETE https://api.hibob.com/v1/company/named-lists/{listName}/{itemId} : This API endpoint deletes a specific item from a named list in the company database.
GET https://api.hibob.com/v1/company/people/fields : This API endpoint retrieves metadata about employee fields, including all employee fields.
DELETE https://api.hibob.com/v1/company/people/fields/{fieldId} : This API endpoint deletes a specific field from the company people fields in the HiBob system.
GET https://api.hibob.com/v1/company/reports : The Get Company Reports API endpoint returns a list of all the company reports with their details.
GET https://api.hibob.com/v1/company/reports/{reportId}/download : The Download Company Report API allows users to download a report data file in the specified format.
GET https://api.hibob.com/v1/company/reports/{reportId}/download-async : This API endpoint asynchronously generates a report based on the specified format (csv or xlsx).

Docs

GET https://api.hibob.com/v1/docs/folders/metadata : This API endpoint retrieves a list of available folders and their metadata, including the folder ID, name, and type.
GET https://api.hibob.com/v1/docs/people/{id} : This API endpoint retrieves a list of documents and their download links for a specified employee.
POST https://api.hibob.com/v1/docs/people/{id}/confidential/upload : This API endpoint allows you to upload a file directly into a confidential folder of a specific employee in Bob.
DELETE https://api.hibob.com/v1/docs/people/{id}/confidential/{docId} : This API endpoint is used to delete a specific document from a confidential folder of a specific employee in Bob.
POST https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/upload : This API endpoint allows you to upload a file directly into a custom folder of a specific employee in Bob.
DELETE https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/{docId} : This API endpoint is used to delete a specific document from a custom folder of a specific employee in Bob.
POST https://api.hibob.com/v1/docs/people/{id}/shared/upload : This API endpoint allows you to upload a file directly into a shared folder of a specific employee in Bob.
DELETE https://api.hibob.com/v1/docs/people/{id}/shared/{docId} : This API endpoint is used to delete a specific document from a shared folder of a specific employee in Bob.

Employees

POST https://api.hibob.com/v1/employees/{employeeId}/invitations : This API endpoint is used to send an invitation to an employee using their Employee ID or email address.
POST https://api.hibob.com/v1/employees/{employeeId}/start-date : This API sets the start date for an employee in the HiBob system.
POST https://api.hibob.com/v1/employees/{identifier}/terminate : This API endpoint is used to change an employee's status to Terminated according to a specified termination date.
POST https://api.hibob.com/v1/employees/{identifier}/uninvite : The Uninvite Employee API is used to revoke access for an employee in the system.

Hiring

POST https://api.hibob.com/v1/hiring/job-ads/search : This API endpoint allows users to search for active job ads as promoted on the Bob career page.
GET https://api.hibob.com/v1/hiring/job-ads/{id} : This API endpoint retrieves the details of a specific job ad that was promoted on the Bob careers page.

Metadata

GET https://api.hibob.com/v1/metadata/objects/position : This API endpoint retrieves a list of all fields of the object type 'position'.

Objects

POST https://api.hibob.com/v1/objects/position/search : This API endpoint allows users to search for company positions by specifying fields to retrieve and filters to apply.

Onboarding

GET https://api.hibob.com/v1/onboarding/wizards : This API endpoint retrieves information about onboarding wizards.

Payroll

GET https://api.hibob.com/v1/payroll/history : The Get Payroll History API retrieves payroll data for employees.

People

POST https://api.hibob.com/v1/people : This API endpoint creates a new employee record in Bob.
GET https://api.hibob.com/v1/people/custom-tables/metadata : This API endpoint retrieves metadata for custom tables in the system.
GET https://api.hibob.com/v1/people/custom-tables/metadata/{custom_table_id} : This API endpoint retrieves metadata for a specific custom table identified by the 'custom_table_id' path parameter.
POST https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id} : This API endpoint allows you to create an entry in a custom table for a specific employee.
DELETE https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id}/{entry_id} : This API endpoint deletes a specific entry from a custom table for a given employee in the HiBob system.
POST https://api.hibob.com/v1/people/search : This API endpoint allows you to search and retrieve data fields of employees using a POST request.
PUT https://api.hibob.com/v1/people/{identifier} : This API endpoint updates the employee record in Bob.
POST https://api.hibob.com/v1/people/{id} : This API endpoint allows you to update employee details by adding equity grants, salary entries, and variable payments for a specific employee identified by their ID.
GET https://api.hibob.com/v1/people/{id}/bank-accounts : This API endpoint retrieves a list of bank account entries for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/bank-accounts/{entry_id} : This API endpoint allows you to delete a specific bank account entry for an employee using their employee ID and the bank account entry ID.
GET https://api.hibob.com/v1/people/{id}/compensation : This API endpoint retrieves comprehensive compensation details for a specified employee, including salary history, variable payments, and equity grants.
PUT https://api.hibob.com/v1/people/{id}/email : This API endpoint allows changing an employee's email address.
POST https://api.hibob.com/v1/people/{id}/employment : This API endpoint is used to add an employment entry for a specific employee identified by their ID.
DELETE https://api.hibob.com/v1/people/{id}/employment/{entry_id} : The Delete Employment Entry API allows you to delete a specific employment entry for a given employee.
GET https://api.hibob.com/v1/people/{id}/equities : This API endpoint retrieves a list of equity grants for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/equities/{entry_id} : This API endpoint deletes a specific equity entry for an employee.
GET https://api.hibob.com/v1/people/{id}/lifecycle : This API endpoint retrieves a list of life-cycle history entries for a specified employee.
GET https://api.hibob.com/v1/people/{id}/salaries : This API endpoint retrieves a list of salary history entries for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/salaries/{entry_id} : This API endpoint allows the deletion of a specific salary entry for an employee.
GET https://api.hibob.com/v1/people/{id}/training : This API endpoint retrieves a list of training records for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/training/{entry_id} : This API endpoint deletes a specific training entry for an employee.
POST https://api.hibob.com/v1/people/{id}/variable : This API endpoint is used to add a variable payment for an employee in the HiBob system.
DELETE https://api.hibob.com/v1/people/{id}/variable/{entry_id} : This API endpoint allows the deletion of a specific variable entry for an employee in the HiBob system.
POST https://api.hibob.com/v1/people/{id}/work : This API endpoint is used to add a work entry for an employee identified by their ID.
PUT https://api.hibob.com/v1/people/{id}/work/{entry_id} : This API endpoint updates an entry in the employee’s work history table.

Profiles

GET https://api.hibob.com/v1/profiles : The Get Employee Profiles API endpoint retrieves a predefined list of fields for all active employees that the service user can access.

Tasks

GET https://api.hibob.com/v1/tasks : This API endpoint retrieves all open tasks for a company.
GET https://api.hibob.com/v1/tasks/people/{id} : This API retrieves all tasks for a specific employee.
POST https://api.hibob.com/v1/tasks/{taskId}/complete : This API endpoint is used to mark a task as complete.

Time Off

POST https://api.hibob.com/v1/timeoff/employees/{id}/adjustments : This API endpoint allows you to create a balance adjustment for a specific employee identified by their ID or email address.
GET https://api.hibob.com/v1/timeoff/employees/{id}/balance : This API retrieves the time off balance for a specified employee based on a given policy type and date.
POST https://api.hibob.com/v1/timeoff/employees/{id}/requests : This API endpoint allows the submission of a new time off request for an employee.
DELETE https://api.hibob.com/v1/timeoff/employees/{id}/requests/{requestId} : The Cancel Time Off Request API allows you to cancel an existing time off request for an employee.
GET https://api.hibob.com/v1/timeoff/outtoday : This API endpoint returns a list of people who have a time off request for today or a specified date.
GET https://api.hibob.com/v1/timeoff/policies : This API endpoint retrieves details about a specific time off policy by its name.
GET https://api.hibob.com/v1/timeoff/policies/names : This API endpoint retrieves a list of policy names for a user's defined policy type.
GET https://api.hibob.com/v1/timeoff/policy-types : This API endpoint retrieves a list of all policy type names available in the system.
GET https://api.hibob.com/v1/timeoff/policy-types/{policyType} : This API endpoint retrieves details about a specific policy type in the time-off system.
POST https://api.hibob.com/v1/timeoff/policy-types/{policyType}/reason-codes : This API endpoint allows adding a list of reason codes for a specified policy type.
GET https://api.hibob.com/v1/timeoff/requests/changes : This API endpoint retrieves a list of time off requests that have been changed (created, canceled, or deleted) since a specified date.
GET https://api.hibob.com/v1/timeoff/whosout : This API endpoint retrieves time off information for a specified 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.

‍