HiBob

Employee's display name. This defaults to first name & last name but can be customized.

A unique identifier representing a specific employee.

The employee's title, This can be Mr, Mrs. Ms. etc.

Employees

Tasks

Parameters

Time Off Requests

Note: Changes to this API are planned to take effect on May 31, 2024. Make sure to review all of the details in the <a href='https://help.hibob.com/hc/en-us/articles/19726260483601'>Working pattern API Changes</a> article in the help center. This API returns a list of requested employees with requested fields. The data is filtered based on the requested fields and access level of the logged-in user. Only viewable categories are returned. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Search for employees

Note: Deprecated at the end of March 2024. Please use /people/search ("Search for employees") instead. This returns a list of all active employees. The data is filtered based on the access level of the logged-in user. Only viewable categories are returned. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Read all company employees

Note: Changes to this API are planned to take effect on May 31, 2024. Make sure to review all of the details in the <a href='https://help.hibob.com/hc/en-us/articles/19726260483601'>Working pattern API Changes</a> article in the help center. This creates a new employee record in Bob. You can include only the fields listed in the [Fields Metadata API](https://apidocs.hibob.com/reference/get_company-people-fields). Note

Create company employee.

Note: Changes to this API are planned to take effect on May 31, 2024. Make sure to review all of the details in the <a href='https://help.hibob.com/hc/en-us/articles/19726260483601'>Working pattern API Changes</a> article in the help center. Returns the employee's fields by the specified ID or email. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Read company employee fields by employee ID.

Note: Deprecated at the end of March 2024. Please use POST /people/{identifier} ("Read company employee fields by ID.") instead. Returns the employee by the specified ID. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Read company employee by ID.

Note: Changes to this API are planned to take effect on May 31, 2024. Make sure to review all of the details in the <a href='https://help.hibob.com/hc/en-us/articles/19726260483601'>Working pattern API Changes</a> article in the help center. This updates the employee record in Bob. You can include only the fields listed in the [Fields Metadata API](https://apidocs.hibob.com/reference/get_company-people-fields) where historical is equal to false. Note

Update company employee.

Revoke access to Bob for an employee.

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

Terminate company employee.

Wizard info includes Wizard ID, name and description. Supported user types: Service.

Get a summary of all onboarding wizards.

Invite an employee with a welcome wizard ID.

Set or update an employee's start date.

Returns a list of all the defined company reports. The data is filtered based on the access level of the user. Only viewable categories are returned.

Read company reports

Returns a report data file in the specified format. Supported user types: Service.

Download the report by ID

Returns the polling URL report file of the specified format under "Location" in the response header.

Get the report download URL for polling

Returns the report data file when it is ready. If the file is not ready yet the response will be 204. It will then have to try again. (This URL is the response of the previous API: https://api.hibob.com/v1/company/reports/reportId/download-async)

Download report by file URL

Returns the public section of all active employees of the logged-in user company. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value. Use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Read the public profile section of all active employees.

Returns the avatar image URL of the employee.

Read avatar for an employee email

Read avatar for an employee ID.

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

Upload employee's avatar by image url

Returns the avatar image URL of the logged-in user.Supported user types: Employee.

Read avatar for logged-in user

Read all open tasks.

Read my tasks

Read tasks of a specific employee 

Mark a task as complete

Change an employee's email address. If you cannot change the self email an invitation will be sent to the new address to verify the email if the employee is invited/active.

Update an employee's email address.

Get all company lists

Get a specific company list by name.

Add a new item to an existing list.

Update an existing item from a list.

Delete an item from an existing list.

Get all company fields.

Create a new field.

Update an existing field

Delete an existing field.

Submit a new time off request.

Submits a new timeoff request of different hours per day. Supported user types: Employee, Service.

Submit a new time off request of different hours per day.

Supplies detailed info about an existing time off request.

Get the details of an existing timeoff request.

Cancels an existing time off request.

Cancel an existing timeoff request

Returns the list of time off requests that are pending, approved or canceled since the specified date.

Get all new/deleted time off requests since the specified date.

Returns time off information for a given date range. Supported user types: Service.

Read a list of who's out of the office.

Returns the list of people that have a time off request today or on the specified date.

Read a list of who's out of the office today or on the specified date.

Get list of reason codes for a given policy type.

Get Policy type reason codes

Add a list of reason codes for a given policy type. Supported user types: Service.

Add a list of reason codes for a given policy type.

Get details about a given policy type.

Get Policy type details

Get a list of all policy type names.

Get all policy types names.

Get Policy details.

Get a list of policy names for the user's defined policy type.

Get a list of policy names for a given policy type.

Retrieve the balance for a given employee, for a given policy type, as of a given date.

Get the balance for a given employee

Create a balance adjustment for a given employee for a given effective date.

Create a balance adjustment.

Import attendance data

Read payroll history.

Upload a document to the employee's shared folder

Upload a document to the employee's confidential folder

Upload a file to the employee's shared folder.

Upload a file to the employee's confidential folder.

Delete specific document from the employee's shared folder.

Delete a specific document from the employee's confidential folder.

Returns a list of documents and download links.

Download employee's documents

Returns a list of work history entries for a given employee. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List employee's work history

Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Creates a new work entry for a given employee.

Updates a work entry from employee's work history

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

Note: Changes to this API are planned to take effect on May 31, 2024. Make sure to review all of the details in the <a href='https://help.hibob.com/hc/en-us/articles/19726260483601'>Working pattern API Changes</a> article in the help center. Returns a list of employment history entries for a given employee. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List employee's employment history.

Creates a new employment entry for a given employee.

Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

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

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

Returns a list of life-cycle history entries for a given employee. Note: TThe values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List employee's life-cycle status history.

Returns a list of salary history entries for a given employee. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List employee's salary history.

Creates a new salary entry for a given employee.

Deletes a salary entry from the employee's list.

Returns a list of equity grants for a given employee. Supported user types: Service Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List the employee's equity grants.

Creates a new equity grant for a given employee.

Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>. - Basic: [] - Bearer: []

Updates an equity grant for an employee

Deletes an equity grant for an employee.

Returns a list of variable payments for a given employee. Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List employee's variable payments

Note:The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

Creates a new variable payment for a given employee.

Deletes a training record for an employee.

Returns a list of training records for a given employee Note: The values of the list fields represent the list item ID and not the list item value. To obtain the corresponding list item value, use the HiBob metadata API to determine the field list name. Then, use the list item ID to locate the list item value. For more information, see <a href='https://apidocs.hibob.com/docs/how-to-work-with-lists-public-api'>How to work with lists Public API</a>.

List the employee's training records.

Creates a new training records for a given employee

Deletes any training records for an employee.

Read metadata of custom tables defined

Read metadata for specific custom table

Read all entries of the given custom table

Create new custom table entry

Update custom table entry

Delete custom table entry

Returns a list of all fields of object type position.

Get all positions fields

Returns a list of the company positions, filtered by the specified attributes. Note

Read company positions

Salesforce

HubSpot

Zoho CRM

Microsoft Dynamics 365

Attio

Jira

Freshsales

Keap

Asana

SugarCRM

Github

Outreach

ActiveCampaign

Capsule CRM

Salesloft

Clickup

Zendesk

Zoho Books

Agile CRM

Teamleader

Copper

Trello Connector

Close

Freshdesk

Linear

Todoist

Deel

Teamwork

# Continuous Import of Tasks to Your App

This scenario enables your application to continuously sync Tasks from any external application to your app's API. It handles the initial import of Tasks and keeps them synchronized when a Task is created, updated, or deleted in the external application.

When receiving Tasks data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Tasks to my App

Import Tasks and receive created/updated or deleted events

Quickbooks

BambooHR

NetSuite

Gusto

ADP Workforce Now

Rippling HR

Google Workspace

Workable

Sage HR

# Delete Employee

This scenario allows your application to delete a Employee from any external application. 
You will pass ID of the Employee you want to delete and Integration.app will handle the rest.

## How It Works

1. **Delete Employee API call**:
   - Call Integration.app REST API or SDK with ID of the Employee you want to delete and Integration.app will send the correct request to the external app.


Delete Employee

Deletes Employee in any external application

Workday

Personio

# Continuous Import of Employees to Your App

This scenario enables your application to continuously sync Employees from any external application to your app's API. It handles the initial import of Employees and keeps them synchronized when a Employee is created, updated, or deleted in the external application.

When receiving Employees data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Employees to my App

Import Employees and receive created/updated or deleted events

# Create Employee

This scenario allows your application to create a Employee in any external application in the same way. 
You will pass Employee fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.


## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to create Employee with and configure mapping to our default model

2. **Create Employee API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Employee data into a format compatible with the selected external application.
   - It then makes an API call to create the Employee in that specific application.


Create Employee

Creates Employee in any external application

# Realtime Full two-way Sync of Employees

This scenario enables your application to fully sync Employees between your app and any external application in both directions. It handles the initial import/export of Employees and then sends events when a Employee is created, updated, or deleted on any side, as close to real-time as possible.

Employee fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Employees in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Employees to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Employees

Bi-directional realtime sync of Employees with records deduplication

# Update Employee

This scenario allows your application to update a Employee in any external application in the same way. 
You will pass  ID of the Employee you want to update and Employee fields in any format your application support and Integration.app will handle mapping of them to the schema of any selected application.
Additionally, if needed, your customers can customize the data mapping based on their specific setup.

## How It Works

1. **Configuration**:
   - You will setup the schema of fields that you wish to update Employee with and configure mapping to our default model

2. **Create Employee API call**:
   - Call Integration.app REST API or SDK with payload matching the field mapping you configured and ID. You can run it for any external application via the same request.
   - When called, Integration.app transforms your Employee data into a format compatible with the selected external application.
   - It then makes an API call to update the Employee in that specific application.


Update Employee

Updates Employee in any external application

# Get all Employees

This scenario enables your application to get a complete list of Employees from any external application to your app's API in the same way. 

When receiving Employees data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Employees along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Employees page by page.


Get all Employees

Imports all Employees from any external application to your App.

# Realtime Full two-way Sync of Tasks

This scenario enables your application to fully sync Tasks between your app and any external application in both directions. It handles the initial import/export of Tasks and then sends events when a Task is created, updated, or deleted on any side, as close to real-time as possible.

Task fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Tasks in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Tasks to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Tasks

Bi-directional realtime sync of Tasks with records deduplication

HiBob API Integration Profile

Data Collections

Operations

Integration Scenarios