Applications

Employees

Parameters

Field Options

Jobs

Users

BambooHR

Get employee data by specifying a set of fields. This is suitable for getting basic employee information, including current values for fields that are part of a historical table, like job title, or compensation information. See the [fields](ref:metadata-get-a-list-of-fields) endpoint for a list of possible fields.

Get Employee

Update an employee, based on employee ID. If employee is currently on a pay schedule syncing with Trax Payroll, or being added to one, the API user will need to update the employee with all of the following required fields for the update to be successful (listed by API field name): employeeNumber, firstName, lastName, dateOfBirth, ssn, gender, maritalStatus, hireDate, address1, city, state, country, employmentHistoryStatus, exempt, payType, payRate, payPer, location, department, and division.

Update Employee

Add a new employee. New employees must have at least a first name and a last name. The ID of the newly created employee is included in the Location header of the response. Other fields can be included. Please see the [fields](ref:metadata-get-a-list-of-fields) endpoint. New Employees added to a pay schedule synced with Trax Payroll must have the following required fields (listed by API field name): employeeNumber, firstName, lastName, dateOfBirth, ssn, gender, maritalStatus, hireDate, address1, city, state, country, employmentHistoryStatus, exempt, payType, payRate, payPer, location, department, and division.

Add Employee

Get Employee Directory

List employee files and categories

Add Employee File Category

Update Employee File

Delete Employee File

Get an Employee File

Upload Employee File

List company files and categories

Add Company File Category

Update Company File

Delete Company File

Get an Company File

Upload Company File

Use this resource to request one of your existing custom company reports from the My Reports or Manage Reports sections in the Reports tab. You can get the report number by hovering over the report name and noting the ID from the URL. At present, only reports from the My Reports or Manage Reports sections are supported. In the future we may implement reports from the Standard Reports section if there is enough demand for it. The report numbers used in this request are different in each company.

Get company report

Use this resource to request BambooHR generate a report. You must specify a type of either "PDF", "XLS", "CSV", "JSON", or "XML". You must specify a list of fields to show on the report. The list of fields is available here. The custom report will return employees regardless of their status, "Active" or "Inactive". This differs from the UI, which by default applies a quick filter to display only "Active" employees.

Request a custom report

Returns a data structure representing all the table rows for a given employee and table combination. The result is not sorted in any particular order.

Gets table rows for a given employee and table combination

Adds a table row. If employee is currently on a pay schedule syncing with Trax Payroll, or being added to one, the row cannot be added if they are missing any required fields for that table. If the API user is adding a row on the compensation table, the row cannot be added if they are missing any of the required employee fields (including fields not on that table).

Adds a table row

Updates a table row. If employee is currently on a pay schedule syncing with Trax Payroll, or being added to one, the row cannot be added if they are missing any required fields for that table. If the API user is updating a row on the compensation table, the row cannot be updated if they are missing any of the required employee fields (including fields not on that table).

Updates a table row.

Deletes a table row

Updates a table row. Fundamentally the same as version 1 so choose a version and stay with it unless other changes occur. Changes from version 1 are now minor with a few variations limited to ACA, payroll, terminated rehire, gusto, benetrac, and final pay date.

Adds a table row. Fundamentally the same as version 1 so choose a version and stay with it unless other changes occur. Changes from version 1 are now minor with a few variations limited to ACA, payroll, terminated rehire, gusto, benetrac, and final pay date.

This API is merely an optimization to avoid downloading all table data for all employees. When you use this API you will provide a timestamp and the results will be limited to just the employees that have changed since the time you provided. This API operates on an employee-last-changed-timestamp, which means that a change in ANY field in the employee record will cause ALL of that employees table rows to show up via this API.

Gets all updated employee table data

This endpoint can help with discovery of fields that are available in an account.

Get a list of fields

This endpoint can help discover table fields available in your BambooHR account.

Get a list of tabular fields

This endpoint will return details for all list fields. Lists that can be edited will have the "manageable" attribute set to yes. Lists with the "multiple" attribute set to yes are fields that can have multiple values. Options with the "archived" attribute set to yes should not appear as current options, but are included so that historical data can reference the value.

Get details for list fields

This resource accepts one or more options. To update an option, specify an ID. You may also remove an option from the list of current values by archiving the value. To create a new option, do not specify an "id" attribute.

Add or Update Values for List Fields

Get a List of Users

This endpoint gets a list of time off types.

Get Time Off Types

This endpoint gets a list of time off policies.

Get Time Off Policies

Get Time Off Requests

A time off request is an entity that describes the decision making process for approving time off. Once a request has been created, a history entry can be created documenting the actual use of time off.

Add a Time Off Request

This endpoint allows you to change the status of a request in the system. You can use this to approve, deny, or cancel a time off request.

Change a Request Status

To use this API make an HTTP PUT where the body of the request is the JSON documented below. A new time off history item will be inserted into the database. On success, a 201 Created code is returned and the "Location" header of the response will contain a URL that identifies the new history item.

Add a Time Off History Item For Time Off Request

To use this API make an HTTP PUT where the body of the request is the JSON documented below. A time off balance adjustment will be inserted into the database. On success, a 201 Created code is returned and the "Location" header of the response will contain a URL that identifies the new history item.

Adjust Time Off Balance

List Time Off Policies for Employee

To use this API make an HTTP PUT where the body of the request is the JSON documented below. A time off policy will be assigned to the employee with accruals starting on the date specified. A null start date will remove the assignment. On success, a 200 Success code is returned and the content of the response will be the same as the List Time off Policies API.

Assign Time Off Policies for an Employee

List Time Off Policies for Employee, Version 1.1

To use this API make an HTTP PUT where the body of the request is the JSON documented below. A time off policy will be assigned to the employee with accruals starting on the date specified. On success, a 200 Success code is returned and the content of the response will be the same as the List Time off Policies API.

Assign Time Off Policies for an Employee, Version 1.1

This endpoint will sum future time off accruals, scheduled time off, and carry-over events to produce estimates for the anticipated time off balance on a given date in the future.

Estimate Future Time Off Balances

This endpoint will return a list, sorted by date, of employees who will be out, and company holidays, for a period of time.

Get a list of Who's Out

Get an employee photo

Store a new employee photo

This API allows for efficient syncing of employee data. When you use this API you will provide a timestamp and the results will be limited to just the employees that have changed since the time you provided. This API operates on an employee-last-changed-timestamp, which means that a change in ANY individual field in the employee record, as well as any change to the employment status, job info, or compensation tables, will cause that employee to be returned via this API.

Gets all updated employee IDs

User Login

Get benefit deduction types

Get a list of company benefits

Add a new company benefit

Get a company benefit

Update a company benefit

Delete a company benefit

Get a list of company benefit types

Get a list of employee benefits

Add an employee benefit

Get benefit coverages

Get employee dependent

This API allows you to change the information for a given dependent ID.

Update an employee dependent

Get all employee dependents

Add an employee dependent

Get benefit plans

Get benefit plan coverages

Get benefit groups

Get benefit group employees

Add a benefit group employee

Get benefit group plans

Get benefit group plan costs

Get employee deductions by benefit plan

Get benefit plan deductions by employee

Get benefit deductions for employee

Get an employee's default withholdings

Add an employee's default withholdings

Clear an employee's default withholdings

Get an employee's direct deposit information

Add an employee's direct deposit information

Clear an employee's direct deposit information

Get an employee's unpaid paystubs

Clear an employee's unpaid paystubs

Add an employee's unpaid paystubs

Get an employee's paystub

Delete an employee's paystub

Add an employee's paystub

Get an hour record

Add an hour record

Edit an hour record

Delete an hour record

Bulk add/edit hour records

Approve employee timesheets

Approve timesheets for employees that are currently clocked in

Get timesheets by ids

Clock in (employee id optional)

Clock out (employee id optional)

Store daily entries

Store clock entries

Delete clock entries

Get a timesheet for an employee

Get a daily entry

Get a clock entry

Is employee clocked in?

Microsoft Sharepoint

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Monday

Freshsales

Slack

Keap

Jira

SugarCRM

Asana

Outreach

Xero

ActiveCampaign

Capsule CRM

Github

Notion

Salesloft

Clickup

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Zendesk

Attio

Copper

Microsoft Teams

Greenhouse Harvest

Zoho Books

Front

Calendly

Close

Freshdesk

Breezy HR

Basecamp

Okta

Deel

Lever

Google Workspace

Microsoft Entra ID

# Continuous Import of Users to Your App

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

When receiving Users 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 Users to my App

Import Users and receive created/updated or deleted events

Quickbooks

Gusto

Rippling HR

Sage HR

ADP Workforce Now

Workable

HiBob

Lightspeed R-Series

# 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

Personio

Workday

Isolved

Everee

# 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

Ashby

Recruitee

Jobnimbus

# Realtime Full two-way Sync of Jobs

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

Job 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 Jobs 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 Jobs 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 Jobs

Bi-directional realtime sync of Jobs with records deduplication

BambooHR API Integration Profile

Build every single integration your customers need with AI