Skip to main content
BambooHR logo
  • Category: human resources
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 42
  • Triggers: 0
  • Slug: BAMBOOHR
  • Version: 20261101_00

Tools

Slug: BAMBOOHR_ATS_CREATE_CANDIDATETool to create a candidate application. Use when adding a new applicant to a specific job opening in BambooHR ATS.

Input Parameters

string
Postal code
string
City of residence
string
Candidate’s email address
integer
required
ID of the job opening to apply for
string
State or province of residence
object
Resume file.
string
Source of the application, e.g., ‘LinkedIn’
string
Candidate’s street address
string
Country code (ISO 2-letter format)
string
required
Candidate’s last name
string
required
Candidate’s first name
string
References information
string
Person who referred the candidate
string
Candidate’s personal website URL
string
Name of the college or university attended
object
Cover letter file.
string
LinkedIn profile URL
string
Candidate’s phone number
string
Date candidate is available to start (YYYY-MM-DD)
string
Desired salary (text)
string
Highest level of education achieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_ATS_CREATE_JOB_OPENINGTool to create a new job opening in BambooHR ATS. Use when you need to open a new job for applicants.

Input Parameters

string ("Draft" | "Open")
required
Status of the job opening.
string
Department name for the job opening.
integer
required
Employee ID of the hiring lead. Use BAMBOOHR_GET_HIRING_LEADS to get valid IDs.
integer
Location ID. Use BAMBOOHR_GET_META_LOCATIONS to get valid IDs.
string
Compensation range as text.
string
required
Title of the job opening.
string
required
Employment type. Valid values depend on company configuration, common values: ‘Full-Time’, ‘Part-Time’, ‘Contractor’, ‘Intern’. Use BAMBOOHR_GET_META_EMPLOYMENT_STATUSES to get valid values.
string
required
Full job description text.
string
Internal job code reference for tracking purposes.
string ("Entry-level" | "Mid-level" | "Experienced" | "Manager/Supervisor" | "Senior Manager/Supervisor" | "Executive" | "Senior Executive")
Minimum experience level.
string ("true" | "false" | "required")
Resume question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Address question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
College question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
References question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Referred by question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Website URL question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Cover letter question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
LinkedIn URL question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Date available question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Desired salary question requirement: true (optional), false (hidden), required.
string ("true" | "false" | "required")
Highest education question requirement: true (optional), false (hidden), required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_ATS_GET_APPLICATIONSTool to list job applications with optional filters. Use when retrieving ATS applications for reporting or integration.

Input Parameters

integer
Page number for pagination (1-indexed).
integer
Filter by job ID.
string
Filter by job status groups: ‘ALL’, ‘DRAFT_AND_OPEN’, ‘Open’, ‘Filled’, ‘Draft’, ‘Deleted’, ‘On Hold’, or ‘Canceled’.
string
Filter by application status name, e.g., ‘New’, ‘Active’, ‘Inactive’, ‘Hired’.
integer
Filter by application status ID (e.g., 1 for ‘New’, 2 for ‘Reviewed’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_BENEFIT_GET_COVERAGESTool to retrieve standard benefit coverage options. Use when you need to fetch all or specific coverages before configuring benefit plans.

Input Parameters

string
ID of the benefit coverage to retrieve. If omitted, the API returns all available benefit coverages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_BENEFIT_GET_MEMBER_EVENTSLists member benefit enrollment events for employees and their dependents over the past year, with optional offset and limit on returned members.

Input Parameters

integer
Maximum number of member benefit records to return (non-negative). Returns all if omitted.
integer
Number of member benefit records to skip before returning results (non-negative). Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_COMPANY_GET_EINSTool to retrieve company Employer Identification Numbers (EINs). Use when you need to fetch your account’s EINs after authenticating.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_COMPANY_GET_INFORMATIONTool to retrieve company information. Use when you need details about the current account’s settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_CREATE_FILE_CATEGORYTool to create new company file categories. Use when organizing company files by adding new categories after confirming desired names.

Input Parameters

array
required
A non-empty list of new company file category names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_CREATE_TIME_OFF_REQUESTTool to submit a new time off request. Use after confirming employee ID and valid payload.

Input Parameters

string
required
End date of the time off (YYYY-MM-DD).
array
Optional list of date entries; each should have ‘ymd’ and ‘amount’ keys.
array
Optional list of note objects to attach; each should have ‘from’ and ‘note’ keys.
string
required
Start date of the time off (YYYY-MM-DD).
number
Total amount for the request (hours or days). If omitted, BambooHR calculates from dates.
string ("requested" | "approved" | "declined")
required
Status of the time off request; usually ‘requested’.
string
required
BambooHR numeric ID of the employee for whom to create the request.
integer
required
ID of the time off policy/type to use.
integer
ID of a previous request to reference or adjust.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_DATASETS_LISTLists available datasets via the BambooHR Datasets API, returning dataset names and labels for discovery before querying.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_DEPENDENTS_CREATETool to add a dependent to an employee. Use when a new dependent needs to be recorded for benefits or HR tracking. Ensure the employee record exists before calling this tool.

Input Parameters

string
Dependent’s Social Security Number (unmasked)
string
Dependent’s city
string
Dependent’s state code (2-character)
string ("male" | "female")
Dependent’s gender
string
Dependent’s country code (2-character ISO)
string
Dependent’s ZIP or postal code
string
required
Dependent’s last name
string
required
Dependent’s first name
string
Dependent’s home phone number
string ("true" | "false")
Dependent’s student status flag; string value ‘true’ or ‘false’
integer
required
BambooHR employee ID to which the dependent will be added
string
Dependent’s middle name
string
required
Dependent’s date of birth in YYYY-MM-DD format
string ("true" | "false")
Dependent’s US citizenship flag; string value ‘true’ or ‘false’
string
Dependent’s address line 1
string
Dependent’s address line 2
string ("spouse" | "child" | "domestic partner" | "step child" | "foster child")
Relationship to the employee; one of spouse, child, domestic partner, step child, foster child

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_DEPENDENTS_GET_ALLTool to retrieve all employee dependents. Use after ensuring your API key has access to benefit settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_EMPLOYEE_CREATETool to create a new employee record. Use when adding employees via BambooHR API. Returns the new employee’s ID.

Input Parameters

string
required
Employee’s last name.
string
required
Employee’s first name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_EMPLOYEE_FILES_CREATE_CATEGORYTool to create new employee file categories. Use when organizing employee files by adding new categories after confirming desired names.

Input Parameters

array
required
A non-empty list of new employee file category names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_EMPLOYEE_GET_CHANGEDGet employee IDs grouped by inserted, updated, or deleted changes since a given timestamp. Use for incremental HR change tracking.

Input Parameters

string
required
Retrieve changes since this timestamp (ISO 8601 format, UTC).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_FILES_LISTList company file categories and their files that the requesting user is permitted to see.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_FILES_UPLOADTool to upload a new company file. Use when you need to add a file to BambooHR after confirming its category and share settings.

Input Parameters

object
File to upload.
string ("yes" | "no")
required
Whether to make the file available to employees (yes or no).
string
required
Category ID to place the new file in.
string
required
File name to associate with the uploaded file.
string
Inline file content to upload as bytes or UTF-8 string, used when FileUploadable is not available.
string
MIME type for the inline content (e.g., ‘text/plain’, ‘application/pdf’). Defaults to application/octet-stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_ALL_EMPLOYEESRetrieves all employees from the BambooHR employee directory including their basic information and status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_APPLICANT_STATUSESTool to retrieve applicant statuses. Use when you need to list ATS statuses for your company; requires ATS settings access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_CUSTOM_EMPLOYEE_FIELDSLists employee field definitions available in the account, including standard and custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_CUSTOM_REPORTSTool to run a custom report by ID or ad-hoc fields. Use when you need to execute a saved report or generate an ad-hoc report and retrieve its results in JSON or file format.

Input Parameters

string
Optional title for the generated report.
array
List of field keys or aliases to include for an ad-hoc report.
string ("CSV" | "PDF" | "XLS" | "XML" | "JSON")
Output format of the report; JSON returns parsed content, others return a file.
string
ID of a saved custom report to execute.
boolean
Whether to include only current employees (true) or all employees (false).
string
ISO8601 datetime to include employees changed since this timestamp.
string ("yes" | "no")
Set to ‘no’ to exclude employees with null lastChanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_EMPLOYEETool to retrieve detailed information for a specific employee. Use when you need individual employee data by ID.

Input Parameters

array
Optional list of field keys to include in the response. If omitted, returns default set of fields.
string
required
The ID of the employee to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_EMPLOYEE_PHOTORetrieve an employee’s profile photo by ID and size, returning its content as Base64 with a filename and MIME type.

Input Parameters

string ("original" | "large" | "medium" | "small" | "xs" | "tiny")
required
Size of the employee photo to retrieve
string
required
BambooHR employee ID whose photo is to be fetched

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_HIRING_LEADSTool to retrieve potential hiring leads (employees who can manage job openings) for use in creating a new job opening. The API key owner must have access to ATS settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_JOB_SUMMARIESRetrieve ATS job opening summaries, optionally filtered by status group and sorted. The authenticated caller must have access to ATS settings.

Input Parameters

string ("created" | "status" | "title")
Field to sort by. Possible values: created, status, title
string ("ASC" | "DESC")
Sort order, either ASC or DESC
string ("ALL" | "DRAFT_AND_OPEN" | "DRAFT" | "OPEN" | "CLOSED")
Filter jobs by status group. Possible values: ALL, DRAFT_AND_OPEN, DRAFT, OPEN, CLOSED

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_META_DEPARTMENTSTool to list department metadata. Use after needing all available department codes and names.

Input Parameters

integer
Maximum number of results to return (non-negative)
integer
Number of results to skip before returning items (non-negative)
string
Case-insensitive substring that the department name must contain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_META_DIVISIONSTool to list all division metadata. Use after authenticating to fetch the account’s divisions.

Input Parameters

integer
Maximum number of results to return (non-negative)
integer
Number of results to skip before returning items (non-negative)
string
Case-insensitive substring that the division name must contain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_META_EMPLOYMENT_STATUSESTool to list all employment status metadata. Use when you need all defined employment statuses for the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_META_JOB_TITLESTool to retrieve job title metadata. Uses the list-field metadata endpoint and extracts the options for the jobTitle field.

Input Parameters

integer
Maximum number of results to return (non-negative)
integer
Number of results to skip before returning items (non-negative)
string
Case-insensitive substring that the job title name must contain
boolean
When false, exclude archived job titles from results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_META_LOCATIONSTool to list location metadata. Use when you need all configured company locations for lookups.

Input Parameters

integer
Maximum number of results to return (non-negative)
integer
Number of results to skip before returning items (non-negative)
string
Case-insensitive substring that the location name must contain
boolean
When false, exclude archived locations from results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_META_TIME_OFF_TYPESTool to list time-off type metadata. Use when you need to discover available time-off types before creating time-off requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_REPORTTool to fetch a built-in or published report in JSON or other formats. Use when you need to retrieve report data or download report files after specifying the report ID and desired output format.

Input Parameters

string ("yes" | "no")
Apply duplicate field filtering: ‘yes’ or ‘no’
string ("CSV" | "PDF" | "XLS" | "XML" | "JSON")
Output format of the report
string
required
ID of the report to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_TIME_OFF_BALANCESRetrieve estimated time-off balances for specified employees as of an optional end date. If employee IDs are omitted, the tool uses the employee directory and processes up to 100 employees by default, subject to the configurable maximum.

Input Parameters

string
End date (YYYY-MM-DD) to estimate balances as of.
array
Optional list of employee IDs to filter balances for.
integer
Maximum number of employees to fetch balances for. Limits API calls to avoid timeouts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_TIME_OFF_POLICIESList time-off policies, with accrual and rollover details when available. A 404 response is returned as an empty policy list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_GET_TIME_OFF_REQUESTSTool to list time-off requests within a date range. Use after confirming start and end dates; supports optional filters for status, employee, and time off type.

Input Parameters

string
Limit results to a specific request ID
string
required
Only show time off on or before this date, format YYYY-MM-DD
string
Comma-separated list of time off type IDs to include
string
required
Only show time off on or after this date, format YYYY-MM-DD
string ("view" | "approve")
Filter by access level; legal values: view, approve
string
Comma-separated list of request statuses; legal values: approved, denied, superseded, requested, canceled
string
Limit results to a specific employee ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_LIST_BUILTIN_REPORTSLists a page of saved custom reports available in the account. Requires the report OAuth scope or an API key with report access permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_META_GET_COUNTRIESRetrieve BambooHR country options for use when updating or validating country fields.

Input Parameters

integer
Maximum number of results to return (non-negative)
integer
Number of results to skip before returning items (non-negative)
string
Case-insensitive substring that the country name must contain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_META_GET_LIST_FIELD_DETAILSTool to get details for all list fields. Use when you need to discover list field options before using them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_META_GET_TABULAR_FIELDSTool to list tabular table fields metadata. Use when you need standard table structures before accessing table rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_META_GET_USERSList company users with basic information, including IDs, names, email addresses, and account status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_UPDATE_EMPLOYEETool to update fields on a specified employee record. Use when you need to modify employee properties via BambooHR API after confirming the target employee ID. Example: “Update employee 12345’s department to Sales”.

Input Parameters

object
required
Key/value pairs of employee fields to update, using BambooHR API field names.
string
required
The BambooHR employee ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BAMBOOHR_UPDATE_TIME_OFF_REQUESTTool to update the status of an existing time-off request. Use when you need to approve, deny, or cancel a request after reviewing it. Example: “Approve time-off request 12345”.

Input Parameters

string
Optional note to include with the status change
string ("approved" | "denied" | "canceled")
required
New status for the time-off request
string
required
ID of the time-off request to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not