Action

Description

Required scopes

List Employees

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

List Employees Directory

Get employee directory with basic employee information

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...

Get Employee

Get detailed information for a specific employee by ID

Create Employee

Create a new employee record in BambooHR

Update Employee

Update an existing employee record

Get Employee Photo

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

List Employee Files

Get a list of files for a specific employee

Get Employee File Categories

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

Upload Employee File

Upload a file to a specific employee's record in 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

List Employee Dependents

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

Create Employee Dependent

Create a new dependent for an employee

Update Employee Dependent

Update an existing employee dependent record

List Who's Out

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

List Time Off Requests

Get a list of time off requests with filtering options

Create Time Off Request

Create a new time off request for an employee

Update Time Off Request Status

Update the status of a time off request

Create Time Off History Item

Add a time off history item for an employee

List Time Off Types

Get a list of available time off types

List Time Off Policies

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

Get Employee Time Off Policies

Get time off policies assigned to a specific employee

Assign Time Off Policies

Assign time off policies to an employee

Update Time Off Balance

Update an employee's time off balance adjustment

Estimate Future Time Off Balances

Estimate future time off balances for an employee

List Benefit Coverages

Get benefit coverage information for employees

List Benefit Deduction Types

Get available benefit deduction types

List Member Benefit Events

Get member benefit events for tracking benefit enrollments and changes

List Goals

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

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...

Create Goal

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

Update Goal

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

Delete Goal

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

Create Goal Comment

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

Close Goal

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

Reopen Goal

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

List Timesheet Entries

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

Clock In Employee

Clock in an employee for time tracking

Clock Out Employee

Clock out an employee for time tracking

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...

Delete Clock Entries

Delete timesheet clock entries by their IDs

Create Or Update Hour Entries

Add or edit timesheet hour entries in bulk

Delete Hour Entries

Delete timesheet hour entries by their IDs

Create Time Tracking Project

Create a time tracking project with optional tasks

Create Hour Record

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

Get Hour Record

Get a specific hour record by ID (legacy endpoint)

Update Hour Record

Update a specific hour record (legacy endpoint)

Delete Hour Record

Delete a specific hour record (legacy endpoint)

List Time Tracking Projects

Get a list of time tracking projects

List Project Tasks

Get the tasks configured for a time tracking project

Create Project Task

Create a task on a time tracking project

List Break Policies

Get a list of break policies

List Break Policy Breaks

Get the breaks configured in a break policy

List Shift Differentials

Get a list of shift differentials

List Company Holidays

Get a list of company holidays

List Company Files

Get a list of company files and categories

Get Company File

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

Upload Company File

Upload a file to a company file category in BambooHR

Update Company File

Update an existing company file

Delete Company File

Delete a company file by its ID

Create Company File Category

Create a new company file category

Create Employee File Category

Create a new employee file category

List Employee Trainings

Get a list of training records for a specific employee

Create Employee Training Record

Create a new training record for an employee

Update Employee Training Record

Update an existing employee training record

Delete Employee Training Record

Delete an employee training record

List Training Types

Get a list of available training types

Create Training Type

Create a new training type

Delete Training Type

Delete a training type by its ID

List Training Categories

Get a list of available training categories

Create Training Category

Create a new training category

List Job Summaries

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

Create Job Opening

Create a new job opening in the applicant tracking system

List Job Applications

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

Get Job Application Details

Get detailed information for a specific job application

Create Candidate

Create a new candidate in the applicant tracking system

List Applicant Statuses

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

Update Applicant Status

Update the status of a job application

Create Application Comment

Add a comment to a job application

List Company Locations

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

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

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

List Users

Get a list of users who can access BambooHR

List Fields

Get a list of all available fields in BambooHR

Get Field Options

Get available options for dataset fields

List Countries

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

Get States By Country

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

List List Fields

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

Create Or Update List Values

Create or update values for a list field

List Tabular Fields

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

Get Employee Table Rows

Get rows from an employee's tabular data

Create Table Row

Add a new row to an employee's tabular data

Update Table Row

Update a row in an employee's tabular data

Delete Table Row

Delete a row from an employee's tabular data

List Reports

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

Get Report

Get details of a specific custom report

Request Custom Report

Generate a custom or company report with specified fields and filters

List Datasets

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

Get Dataset Fields

Get fields available in a specific dataset

Get Dataset Data

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

List Webhooks

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

Get Webhook

Get detailed information for a specific webhook

Create Webhook

Create a new webhook to receive BambooHR events

Update Webhook

Update an existing webhook configuration

Delete Webhook

Delete a webhook by its ID

Get Webhook Logs

Get logs for a specific webhook to debug delivery issues

List Monitor Fields

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

## Events

Employees

3 events

Event

Description