> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BambooHR

> How to set up the BambooHR connector, plus the actions and events that are available.

![BambooHR](https://stackone-logos.com/api/bamboohr/filled/svg)

v2.1.2[See changelog](https://docs.stackone.com/connectors/bamboohr/changelog.md)

[107 actions](#actions) · [3 events](#events) · 2 auth methods

HRIS
ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/bamboohr/guides/connector-profile/oauth-2-0.md)
>
> Provides granular scope control over employee, compensation, time-off, and other data categories.

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/bamboohr/guides/connector-profile/api-key.md)
>
> Inherits the full permissions of the generating user. Simpler to set up but no granular scope control.

Optionally, configure receiving Events for BambooHR into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/bamboohr/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/bamboohr/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/bamboohr/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

benefit

company:info

company\_file

company\_file.write

employee

employee.write

employee:dependent

employee:dependent.write

employee:file

employee:file.write

employee:photo

employee:photo.write

employee\_directory

field

field.write

goal

goal.write

hiring:applications

hiring:applications.write

holidays

public.user

report

time\_off

time\_off.write

time\_tracking

time\_tracking.write

time\_tracking:breaks

time\_tracking:project

time\_tracking:project.write

time\_tracking:shift\_differentials

training

training.write

user

webhooks

webhooks.write

No scopes found

107 actions

ActionDescriptionRequired scopes

List Employees`bamboohr_list_employees`

List or search employees with comprehensive employee data - resolves an employee ID from a name and filters employees by...

`employee`

List Employees Directory`bamboohr_list_employees_directory`

Get employee directory with basic employee information

`employee_directory`

Get Changed Employee IDs`bamboohr_get_changed_employee_ids`

Returns IDs (not full records) of employees whose data changed since a given timestamp. Use the returned IDs with get\_em...

`public.user`

Get Employee`bamboohr_get_employee`

Get detailed information for a specific employee by ID

`employee`

Create Employee`bamboohr_create_employee`

Create a new employee record in BambooHR

`employee.write`

Update Employee`bamboohr_update_employee`

Update an existing employee record

`employee.write`

Get Employee Photo`bamboohr_get_employee_photo`

Get an employee's profile photo. Requires appropriate permissions to access employee photos.

`employee:photo`

List Employee Files`bamboohr_list_employee_files`

Get a list of files for a specific employee

`employee:file`

Get Employee File Categories`bamboohr_get_employee_file_categories`

Get available file categories for a specific employee. Note - BambooHR returns categories as part of the file listing en...

`employee:file`

Upload Employee File`bamboohr_upload_employee_file`

Upload a file to a specific employee's record in BambooHR

`employee:file.write`

Upload Employee Photo`bamboohr_upload_employee_photo`

Upload a photo for a specific employee. Photo must be square (min 150x150 pixels, max 20MB) in JPEG, PNG, or BMP format

`employee:photo.write`

List Employee Dependents`bamboohr_list_employee_dependents`

Get a list of dependents for a specific employee. Requires appropriate permissions to access employee dependent informat...

`employee:dependent`

Create Employee Dependent`bamboohr_create_employee_dependent`

Create a new dependent for an employee

`employee:dependent.write`

Update Employee Dependent`bamboohr_update_employee_dependent`

Update an existing employee dependent record

`employee:dependent.write`

List Who's Out`bamboohr_list_whos_out`

Get a list of who is out on a given date or date range

`time_off`

List Time Off Requests`bamboohr_list_time_off_requests`

Get a list of time off requests with filtering options

`time_off`

Create Time Off Request`bamboohr_create_time_off_request`

Create a new time off request for an employee

`time_off.write`

Update Time Off Request Status`bamboohr_update_time_off_request_status`

Update the status of a time off request

`time_off.write`

Create Time Off History Item`bamboohr_create_time_off_history_item`

Add a time off history item for an employee

`time_off.write`

List Time Off Types`bamboohr_list_time_off_types`

Get a list of available time off types

`time_off`

List Time Off Policies`bamboohr_list_time_off_policies`

List all company-wide time off policies (not employee-specific)

`time_off`

Get Employee Time Off Policies`bamboohr_get_employee_time_off_policies`

Get time off policies assigned to a specific employee

`time_off`

Assign Time Off Policies`bamboohr_assign_time_off_policies`

Assign time off policies to an employee

`time_off.write`

Update Time Off Balance`bamboohr_update_time_off_balance`

Update an employee's time off balance adjustment

`time_off.write`

Estimate Future Time Off Balances`bamboohr_estimate_future_time_off_balances`

Estimate future time off balances for an employee

`time_off`

List Benefit Coverages`bamboohr_list_benefit_coverages`

Get benefit coverage information for employees

`benefit`

List Benefit Deduction Types`bamboohr_list_benefit_deduction_types`

Get available benefit deduction types

`benefit`

List Member Benefit Events`bamboohr_list_member_benefit_events`

Get member benefit events for tracking benefit enrollments and changes

`benefit`

List Goals`bamboohr_list_goals`

Get a list of goals for a specific employee. Requires Goals module to be enabled and appropriate permissions.

`goal`

List Goal Alignment Options`bamboohr_list_goal_alignment_options`

Get the goals that can be used as alignment targets for an employee's goals. Requires Goals module to be enabled and app...

`goal`

Create Goal`bamboohr_create_goal`

Create a new goal for an employee. Requires Goals module to be enabled.

`goal.write`

Update Goal`bamboohr_update_goal`

Update an existing goal with all fields. Requires Goals module to be enabled.

`goal.write`

Delete Goal`bamboohr_delete_goal`

Delete a goal by its ID. Requires Goals module to be enabled.

`goal.write`

Create Goal Comment`bamboohr_create_goal_comment`

Add a comment to a goal. Requires Goals module to be enabled.

`goal.write`

Close Goal`bamboohr_close_goal`

Close a goal and mark it as complete. Requires Goals module to be enabled.

`goal.write`

Reopen Goal`bamboohr_reopen_goal`

Reopen a closed goal. Requires Goals module to be enabled.

`goal.write`

List Timesheet Entries`bamboohr_list_timesheet_entries`

Get all timesheet entries for a given period of time. Requires time tracking module to be enabled and appropriate permis...

`time_tracking`

Clock In Employee`bamboohr_clock_in_employee`

Clock in an employee for time tracking

`time_tracking.write`

Clock Out Employee`bamboohr_clock_out_employee`

Clock out an employee for time tracking

`time_tracking.write`

Create Or Update Clock Entries`bamboohr_create_or_update_clock_entries`

Record or edit timesheet entries that carry explicit start and end times (clock entries) for one or more employees and d...

`time_tracking.write`

Delete Clock Entries`bamboohr_delete_clock_entries`

Delete timesheet clock entries by their IDs

`time_tracking.write`

Create Or Update Hour Entries`bamboohr_create_or_update_hour_entries`

Add or edit timesheet hour entries in bulk

`time_tracking.write`

Delete Hour Entries`bamboohr_delete_hour_entries`

Delete timesheet hour entries by their IDs

`time_tracking.write`

Create Time Tracking Project`bamboohr_create_time_tracking_project`

Create a time tracking project with optional tasks

`time_tracking:project.write`

Create Hour Record`bamboohr_create_hour_record`

Add hours worked for an employee (legacy endpoint). Requires time tracking module to be enabled with proper project and...

`time_tracking.write`

Get Hour Record`bamboohr_get_hour_record`

Get a specific hour record by ID (legacy endpoint)

`time_tracking`

Update Hour Record`bamboohr_update_hour_record`

Update a specific hour record (legacy endpoint)

`time_tracking.write`

Delete Hour Record`bamboohr_delete_hour_record`

Delete a specific hour record (legacy endpoint)

`time_tracking.write`

List Time Tracking Projects`bamboohr_list_time_tracking_projects`

Get a list of time tracking projects

`time_tracking:project`

List Project Tasks`bamboohr_list_project_tasks`

Get the tasks configured for a time tracking project

`time_tracking:project`

Create Project Task`bamboohr_create_project_task`

Create a task on a time tracking project

`time_tracking:project.write`

List Break Policies`bamboohr_list_break_policies`

Get a list of break policies

`time_tracking:breaks`

List Break Policy Breaks`bamboohr_list_break_policy_breaks`

Get the breaks configured in a break policy

`time_tracking:breaks`

List Shift Differentials`bamboohr_list_shift_differentials`

Get a list of shift differentials

`time_tracking:shift_differentials`

List Company Holidays`bamboohr_list_holidays`

Get a list of company holidays

`holidays`

List Company Files`bamboohr_list_company_files`

Get a list of company files and categories

`company_file`

Get Company File`bamboohr_get_company_file`

Get a specific company file by ID. Returns binary file data. Requires appropriate permissions to download company files.

`company_file`

Upload Company File`bamboohr_upload_company_file`

Upload a file to a company file category in BambooHR

`company_file.write`

Update Company File`bamboohr_update_company_file`

Update an existing company file

`company_file.write`

Delete Company File`bamboohr_delete_company_file`

Delete a company file by its ID

`company_file.write`

Create Company File Category`bamboohr_create_company_file_category`

Create a new company file category

`company_file.write`

Create Employee File Category`bamboohr_create_employee_file_category`

Create a new employee file category

`employee:file.write`

List Employee Trainings`bamboohr_list_employee_trainings`

Get a list of training records for a specific employee

`training`

Create Employee Training Record`bamboohr_create_employee_training_record`

Create a new training record for an employee

`training.write`

Update Employee Training Record`bamboohr_update_employee_training_record`

Update an existing employee training record

`training.write`

Delete Employee Training Record`bamboohr_delete_employee_training_record`

Delete an employee training record

`training.write`

List Training Types`bamboohr_list_training_types`

Get a list of available training types

`training`

Create Training Type`bamboohr_create_training_type`

Create a new training type

`training.write`

Delete Training Type`bamboohr_delete_training_type`

Delete a training type by its ID

`training.write`

List Training Categories`bamboohr_list_training_categories`

Get a list of available training categories

`training`

Create Training Category`bamboohr_create_training_category`

Create a new training category

`training.write`

List Job Summaries`bamboohr_list_job_summaries`

Get a list of job openings with summary information. Requires Applicant Tracking System (ATS) module to be enabled and a...

`hiring:applications`

Create Job Opening`bamboohr_create_job_opening`

Create a new job opening in the applicant tracking system

List Job Applications`bamboohr_list_job_applications`

Get a list of job applications with filtering options. Requires Applicant Tracking System (ATS) module to be enabled and...

`hiring:applications`

Get Job Application Details`bamboohr_get_job_application_details`

Get detailed information for a specific job application

`hiring:applications`

Create Candidate`bamboohr_create_candidate`

Create a new candidate in the applicant tracking system

`hiring:applications.write`

List Applicant Statuses`bamboohr_list_applicant_statuses`

Get a list of available applicant statuses. Requires Applicant Tracking System (ATS) module to be enabled and appropriat...

`hiring:applications`

Update Applicant Status`bamboohr_update_applicant_status`

Update the status of a job application

`hiring:applications.write`

Create Application Comment`bamboohr_create_application_comment`

Add a comment to a job application

`hiring:applications.write`

List Company Locations`bamboohr_list_company_locations`

Get a list of company locations for job postings. Requires Applicant Tracking System (ATS) module to be enabled and appr...

`hiring:applications`

List Hiring Leads`bamboohr_list_hiring_leads`

Get a list of employees who can be hiring leads. Requires Applicant Tracking System (ATS) module to be enabled and appro...

Get Company Information`bamboohr_get_company_information`

Get basic company information and settings. Requires company admin permissions to access this endpoint.

`company:info`

List Users`bamboohr_list_users`

Get a list of users who can access BambooHR

`user`

List Fields`bamboohr_list_fields`

Get a list of all available fields in BambooHR

`field`

Get Field Options`bamboohr_get_field_options`

Get available options for dataset fields

`field`

List Countries`bamboohr_list_countries`

Get a list of available countries for address fields. Requires admin-level permissions or special OAuth scope.

`field`

Get States By Country`bamboohr_get_states_by_country`

Get states/provinces for a specific country. Requires admin-level permissions or special OAuth scope.

`field`

List List Fields`bamboohr_list_list_fields`

Get details for all list fields including available options and their IDs. Use this to retrieve dropdown/select field op...

`field`

Create Or Update List Values`bamboohr_create_or_update_list_values`

Create or update values for a list field

`field.write`

List Tabular Fields`bamboohr_list_tabular_fields`

Get available tabular fields (tables) for employee data. Requires appropriate permissions to access metadata.

`field`

Get Employee Table Rows`bamboohr_get_employee_table_rows`

Get rows from an employee's tabular data

`employee`

Create Table Row`bamboohr_create_table_row`

Add a new row to an employee's tabular data

`employee.write`

Update Table Row`bamboohr_update_table_row`

Update a row in an employee's tabular data

`employee.write`

Delete Table Row`bamboohr_delete_table_row`

Delete a row from an employee's tabular data

`employee.write`

List Reports`bamboohr_list_reports`

Get a list of available custom reports. Requires appropriate permissions to access reporting functionality.

`report`

Get Report`bamboohr_get_report`

Get details of a specific custom report

`report`

Request Custom Report`bamboohr_request_custom_report`

Generate a custom or company report with specified fields and filters

`report`

List Datasets`bamboohr_list_datasets`

Get a list of available datasets for reporting. Requires appropriate permissions to access reporting functionality.

`report`

Get Dataset Fields`bamboohr_get_dataset_fields`

Get fields available in a specific dataset

`report`

Get Dataset Data`bamboohr_get_dataset_data`

Query data from a specific dataset with filtering, sorting, and aggregation capabilities. Supports complex queries with...

`report`

List Webhooks`bamboohr_list_webhooks`

Get a list of webhooks configured for the API key. Requires webhooks feature to be enabled and appropriate permissions.

`webhooks`

Get Webhook`bamboohr_get_webhook`

Get detailed information for a specific webhook

`webhooks`

Create Webhook`bamboohr_create_webhook`

Create a new webhook to receive BambooHR events

`webhooks.write`

Update Webhook`bamboohr_update_webhook`

Update an existing webhook configuration

`webhooks.write`

Delete Webhook`bamboohr_delete_webhook`

Delete a webhook by its ID

`webhooks.write`

Get Webhook Logs`bamboohr_get_webhook_logs`

Get logs for a specific webhook to debug delivery issues

`webhooks`

List Monitor Fields`bamboohr_list_monitor_fields`

Get a list of fields that can be monitored by webhooks. Requires webhooks feature to be enabled and appropriate permissi...

`webhooks`

## Events

Tags

Select all
|
Clear

Employees

No tags found

3 events

EventDescriptionTags

Employee Created`bamboohr_webhook_employee_created`

Fired when a new employee record is created in BambooHR.

Employees

Employee Updated`bamboohr_webhook_employee_updated`

Fired when one or more monitored fields on an employee record change in BambooHR.

Employees

Employee Deleted`bamboohr_webhook_employee_deleted`

Fired when an employee record is deleted from BambooHR.

Employees


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.