BambooHR
Manage employees, time-off, and HR reports in BambooHR
Integrate BambooHR into your workflow. List and retrieve employees, add new employees, update employee information, manage time-off requests, and run custom reports from your BambooHR account.
List employees from BambooHR with optional field selection and pagination
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
companyDomain | string | Yes | No description |
fields | string | No | No description |
per_page | number | No | No description |
page | number | No | No description |
| Parameter | Type | Description |
|---|
employees | array | List of employees |
↳ id | string | Employee ID |
↳ displayName | string | Display name |
↳ firstName | string | First name |
↳ lastName | string | Last name |
↳ jobTitle | string | Job title |
↳ department | string | Department |
↳ workEmail | string | Work email |
↳ mobilePhone | string | Mobile phone |
↳ status | string | Employment status (Active, Inactive) |
count | number | Number of employees returned |
Get a specific employee by ID from BambooHR with full details
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
companyDomain | string | Yes | No description |
employeeId | string | Yes | No description |
fields | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | Employee ID |
displayName | string | Display name |
firstName | string | First name |
lastName | string | Last name |
jobTitle | string | Job title |
department | string | Department |
workEmail | string | Work email |
mobilePhone | string | Mobile phone |
workPhone | string | Work phone |
hireDate | string | Hire date (YYYY-MM-DD) |
terminationDate | string | Termination date (YYYY-MM-DD) |
status | string | Employment status (Active, Inactive) |
supervisor | string | Supervisor name |
location | string | Work location |
division | string | Division |
employmentHistoryStatus | string | Employment history status |
gender | string | Gender |
nationality | string | Nationality |
dateOfBirth | string | Date of birth (YYYY-MM-DD) |
address1 | string | Street address |
city | string | City |
country | string | Country |
custom_fields | object | Custom field values |
Add a new employee to BambooHR
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
companyDomain | string | Yes | No description |
firstName | string | Yes | No description |
lastName | string | Yes | No description |
jobTitle | string | No | No description |
department | string | No | No description |
workEmail | string | No | No description |
hireDate | string | No | No description |
| Parameter | Type | Description |
|---|
id | string | New employee ID |
firstName | string | First name |
lastName | string | Last name |
Update an existing employee record in BambooHR
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
companyDomain | string | Yes | No description |
employeeId | string | Yes | No description |
firstName | string | No | No description |
lastName | string | No | No description |
jobTitle | string | No | No description |
department | string | No | No description |
workEmail | string | No | No description |
mobilePhone | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the update succeeded |
employeeId | string | Updated employee ID |
List time-off requests for a date range in BambooHR
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
companyDomain | string | Yes | No description |
start | string | Yes | No description |
end | string | Yes | No description |
status | string | No | No description |
employeeId | string | No | No description |
| Parameter | Type | Description |
|---|
requests | array | List of time-off requests |
↳ id | string | Request ID |
↳ employeeId | string | Employee ID |
↳ name | string | Employee name |
↳ start | string | Start date (YYYY-MM-DD) |
↳ end | string | End date (YYYY-MM-DD) |
↳ created | string | Created timestamp |
↳ status | object | Request status details |
↳ type | object | Time-off type |
↳ amount | object | Time-off amount |
↳ actions | object | Available actions on this request |
count | number | Number of requests returned |
Retrieve a saved company report from BambooHR
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | No description |
companyDomain | string | Yes | No description |
reportId | string | Yes | No description |
format | string | No | No description |
| Parameter | Type | Description |
|---|
title | string | Report title |
fields | array | Report field definitions |
↳ id | string | Field ID |
↳ name | string | Field name |
employees | array | Employee rows in the report |