> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# BambooHR

> BambooHR is a cloud-based human resources management system (HRMS) that helps businesses manage their employees, payroll, and benefits.

![BambooHR logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/bamboohr.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=d148a2170adec0c17aadc4c9cd9d03c8)

* **Category:** human resources
* **Auth:** OAUTH2, API\_KEY
* **Composio-managed OAuth available?** No
* **Tools:** 42
* **Triggers:** 0
* **Slug:** `BAMBOOHR`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Candidate Application
>
> **Slug:** `BAMBOOHR_ATS_CREATE_CANDIDATE`
>
> Tool to create a candidate application. Use when adding a new applicant to a specific job opening in BambooHR ATS.
>
> #### Input Parameters
>
> **zip** `string`
>
> Postal code
>
> **city** `string`
>
> City of residence
>
> **email** `string`
>
> Candidate's email address
>
> **jobId** `integer` *required*
>
> ID of the job opening to apply for
>
> **state** `string`
>
> State or province of residence
>
> **resume** `object`
>
> Resume file.
>
> **source** `string`
>
> Source of the application, e.g., 'LinkedIn'
>
> **address** `string`
>
> Candidate's street address
>
> **country** `string`
>
> Country code (ISO 2-letter format)
>
> **lastName** `string` *required*
>
> Candidate's last name
>
> **firstName** `string` *required*
>
> Candidate's first name
>
> **references** `string`
>
> References information
>
> **referredBy** `string`
>
> Person who referred the candidate
>
> **websiteUrl** `string`
>
> Candidate's personal website URL
>
> **collegeName** `string`
>
> Name of the college or university attended
>
> **coverLetter** `object`
>
> Cover letter file.
>
> **linkedinUrl** `string`
>
> LinkedIn profile URL
>
> **phoneNumber** `string`
>
> Candidate's phone number
>
> **dateAvailable** `string`
>
> Date candidate is available to start (YYYY-MM-DD)
>
> **desiredSalary** `string`
>
> Desired salary (text)
>
> **highestEducation** `string`
>
> Highest level of education achieved
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Job Opening
>
> **Slug:** `BAMBOOHR_ATS_CREATE_JOB_OPENING`
>
> Tool to create a new job opening in BambooHR ATS. Use when you need to open a new job for applicants.
>
> #### Input Parameters
>
> **jobStatus** `string ("Draft" | "Open")` *required*
>
> Status of the job opening.
>
> **department** `string`
>
> Department name for the job opening.
>
> **hiringLead** `integer` *required*
>
> Employee ID of the hiring lead. Use BAMBOOHR\_GET\_HIRING\_LEADS to get valid IDs.
>
> **jobLocation** `integer`
>
> Location ID. Use BAMBOOHR\_GET\_META\_LOCATIONS to get valid IDs.
>
> **compensation** `string`
>
> Compensation range as text.
>
> **postingTitle** `string` *required*
>
> Title of the job opening.
>
> **employmentType** `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.
>
> **jobDescription** `string` *required*
>
> Full job description text.
>
> **internalJobCode** `string`
>
> Internal job code reference for tracking purposes.
>
> **minimumExperience** `string ("Entry-level" | "Mid-level" | "Experienced" | "Manager/Supervisor" | "Senior Manager/Supervisor" | "Executive" | "Senior Executive")`
>
> Minimum experience level.
>
> **applicationQuestionResume** `string ("true" | "false" | "required")`
>
> Resume question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionAddress** `string ("true" | "false" | "required")`
>
> Address question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionCollege** `string ("true" | "false" | "required")`
>
> College question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionReferences** `string ("true" | "false" | "required")`
>
> References question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionReferredBy** `string ("true" | "false" | "required")`
>
> Referred by question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionWebsiteUrl** `string ("true" | "false" | "required")`
>
> Website URL question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionCoverLetter** `string ("true" | "false" | "required")`
>
> Cover letter question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionLinkedinUrl** `string ("true" | "false" | "required")`
>
> LinkedIn URL question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionDateAvailable** `string ("true" | "false" | "required")`
>
> Date available question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionDesiredSalary** `string ("true" | "false" | "required")`
>
> Desired salary question requirement: true (optional), false (hidden), required.
>
> **applicationQuestionHighestEducation** `string ("true" | "false" | "required")`
>
> Highest education question requirement: true (optional), false (hidden), required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Job Applications
>
> **Slug:** `BAMBOOHR_ATS_GET_APPLICATIONS`
>
> Tool to list job applications with optional filters. Use when retrieving ATS applications for reporting or integration.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (1-indexed).
>
> **jobId** `integer`
>
> Filter by job ID.
>
> **jobStatusGroups** `string`
>
> Filter by job status groups: 'ALL', 'DRAFT\_AND\_OPEN', 'Open', 'Filled', 'Draft', 'Deleted', 'On Hold', or 'Canceled'.
>
> **applicationStatus** `string`
>
> Filter by application status name, e.g., 'New', 'Active', 'Inactive', 'Hired'.
>
> **applicationStatusId** `integer`
>
> Filter by application status ID (e.g., 1 for 'New', 2 for 'Reviewed').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Benefit Coverages
>
> **Slug:** `BAMBOOHR_BENEFIT_GET_COVERAGES`
>
> Tool to retrieve standard benefit coverage options. Use when you need to fetch all or specific coverages before configuring benefit plans.
>
> #### Input Parameters
>
> **coverage\_id** `string`
>
> ID of the benefit coverage to retrieve. If omitted, the API returns all available benefit coverages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Member Benefit Events
>
> **Slug:** `BAMBOOHR_BENEFIT_GET_MEMBER_EVENTS`
>
> Lists member benefit enrollment events for employees and their dependents over the past year, with optional offset and limit on returned members.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of member benefit records to return (non-negative). Returns all if omitted.
>
> **offset** `integer`
>
> Number of member benefit records to skip before returning results (non-negative). Defaults to 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company EINs
>
> **Slug:** `BAMBOOHR_COMPANY_GET_EINS`
>
> Tool to retrieve company Employer Identification Numbers (EINs). Use when you need to fetch your account's EINs after authenticating.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Information
>
> **Slug:** `BAMBOOHR_COMPANY_GET_INFORMATION`
>
> Tool to retrieve company information. Use when you need details about the current account's settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create File Category
>
> **Slug:** `BAMBOOHR_CREATE_FILE_CATEGORY`
>
> Tool to create new company file categories. Use when organizing company files by adding new categories after confirming desired names.
>
> #### Input Parameters
>
> **categories** `array` *required*
>
> A non-empty list of new company file category names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Time Off Request
>
> **Slug:** `BAMBOOHR_CREATE_TIME_OFF_REQUEST`
>
> Tool to submit a new time off request. Use after confirming employee ID and valid payload.
>
> #### Input Parameters
>
> **end** `string` *required*
>
> End date of the time off (YYYY-MM-DD).
>
> **dates** `array`
>
> Optional list of date entries; each should have 'ymd' and 'amount' keys.
>
> **notes** `array`
>
> Optional list of note objects to attach; each should have 'from' and 'note' keys.
>
> **start** `string` *required*
>
> Start date of the time off (YYYY-MM-DD).
>
> **amount** `number`
>
> Total amount for the request (hours or days). If omitted, BambooHR calculates from dates.
>
> **status** `string ("requested" | "approved" | "declined")` *required*
>
> Status of the time off request; usually 'requested'.
>
> **employeeId** `string` *required*
>
> BambooHR numeric ID of the employee for whom to create the request.
>
> **timeOffTypeId** `integer` *required*
>
> ID of the time off policy/type to use.
>
> **previousRequest** `integer`
>
> ID of a previous request to reference or adjust.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Datasets
>
> **Slug:** `BAMBOOHR_DATASETS_LIST`
>
> Lists available datasets via the BambooHR Datasets API, returning dataset names and labels for discovery before querying.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee Dependent
>
> **Slug:** `BAMBOOHR_DEPENDENTS_CREATE`
>
> Tool 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
>
> **ssn** `string`
>
> Dependent's Social Security Number (unmasked)
>
> **city** `string`
>
> Dependent's city
>
> **state** `string`
>
> Dependent's state code (2-character)
>
> **gender** `string ("male" | "female")`
>
> Dependent's gender
>
> **country** `string`
>
> Dependent's country code (2-character ISO)
>
> **zipCode** `string`
>
> Dependent's ZIP or postal code
>
> **lastName** `string` *required*
>
> Dependent's last name
>
> **firstName** `string` *required*
>
> Dependent's first name
>
> **homePhone** `string`
>
> Dependent's home phone number
>
> **isStudent** `string ("true" | "false")`
>
> Dependent's student status flag; string value 'true' or 'false'
>
> **employeeId** `integer` *required*
>
> BambooHR employee ID to which the dependent will be added
>
> **middleName** `string`
>
> Dependent's middle name
>
> **dateOfBirth** `string` *required*
>
> Dependent's date of birth in YYYY-MM-DD format
>
> **isUsCitizen** `string ("true" | "false")`
>
> Dependent's US citizenship flag; string value 'true' or 'false'
>
> **addressLine1** `string`
>
> Dependent's address line 1
>
> **addressLine2** `string`
>
> Dependent's address line 2
>
> **relationship** `string ("spouse" | "child" | "domestic partner" | "step child" | "foster child")`
>
> Relationship to the employee; one of spouse, child, domestic partner, step child, foster child
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Employee Dependents
>
> **Slug:** `BAMBOOHR_DEPENDENTS_GET_ALL`
>
> Tool to retrieve all employee dependents. Use after ensuring your API key has access to benefit settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee
>
> **Slug:** `BAMBOOHR_EMPLOYEE_CREATE`
>
> Tool to create a new employee record. Use when adding employees via BambooHR API. Returns the new employee's ID.
>
> #### Input Parameters
>
> **lastName** `string` *required*
>
> Employee's last name.
>
> **firstName** `string` *required*
>
> Employee's first name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee File Category
>
> **Slug:** `BAMBOOHR_EMPLOYEE_FILES_CREATE_CATEGORY`
>
> Tool to create new employee file categories. Use when organizing employee files by adding new categories after confirming desired names.
>
> #### Input Parameters
>
> **categories** `array` *required*
>
> A non-empty list of new employee file category names.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Changed Employees
>
> **Slug:** `BAMBOOHR_EMPLOYEE_GET_CHANGED`
>
> Get employee IDs grouped by inserted, updated, or deleted changes since a given timestamp. Use for incremental HR change tracking.
>
> #### Input Parameters
>
> **since** `string` *required*
>
> Retrieve changes since this timestamp (ISO 8601 format, UTC).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Files
>
> **Slug:** `BAMBOOHR_FILES_LIST`
>
> List company file categories and their files that the requesting user is permitted to see.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Company File
>
> **Slug:** `BAMBOOHR_FILES_UPLOAD`
>
> Tool 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
>
> **file** `object`
>
> File to upload.
>
> **share** `string ("yes" | "no")` *required*
>
> Whether to make the file available to employees (yes or no).
>
> **category** `string` *required*
>
> Category ID to place the new file in.
>
> **fileName** `string` *required*
>
> File name to associate with the uploaded file.
>
> **rawContent** `string`
>
> Inline file content to upload as bytes or UTF-8 string, used when FileUploadable is not available.
>
> **rawMimetype** `string`
>
> MIME type for the inline content (e.g., 'text/plain', 'application/pdf'). Defaults to application/octet-stream.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Employees
>
> **Slug:** `BAMBOOHR_GET_ALL_EMPLOYEES`
>
> Retrieves all employees from the BambooHR employee directory including their basic information and status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Applicant Statuses
>
> **Slug:** `BAMBOOHR_GET_APPLICANT_STATUSES`
>
> Tool to retrieve applicant statuses. Use when you need to list ATS statuses for your company; requires ATS settings access.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Employee Fields
>
> **Slug:** `BAMBOOHR_GET_CUSTOM_EMPLOYEE_FIELDS`
>
> Lists employee field definitions available in the account, including standard and custom fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run Custom Report
>
> **Slug:** `BAMBOOHR_GET_CUSTOM_REPORTS`
>
> Tool 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
>
> **title** `string`
>
> Optional title for the generated report.
>
> **fields** `array`
>
> List of field keys or aliases to include for an ad-hoc report.
>
> **format** `string ("CSV" | "PDF" | "XLS" | "XML" | "JSON")`
>
> Output format of the report; JSON returns parsed content, others return a file.
>
> **reportId** `string`
>
> ID of a saved custom report to execute.
>
> **onlyCurrent** `boolean`
>
> Whether to include only current employees (true) or all employees (false).
>
> **filters\_last\_changed\_value** `string`
>
> ISO8601 datetime to include employees changed since this timestamp.
>
> **filters\_last\_changed\_include\_null** `string ("yes" | "no")`
>
> Set to 'no' to exclude employees with null lastChanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee
>
> **Slug:** `BAMBOOHR_GET_EMPLOYEE`
>
> Tool to retrieve detailed information for a specific employee. Use when you need individual employee data by ID.
>
> #### Input Parameters
>
> **fields** `array`
>
> Optional list of field keys to include in the response. If omitted, returns default set of fields.
>
> **employeeId** `string` *required*
>
> The ID of the employee to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Photo
>
> **Slug:** `BAMBOOHR_GET_EMPLOYEE_PHOTO`
>
> Retrieve an employee's profile photo by ID and size, returning its content as Base64 with a filename and MIME type.
>
> #### Input Parameters
>
> **size** `string ("original" | "large" | "medium" | "small" | "xs" | "tiny")` *required*
>
> Size of the employee photo to retrieve
>
> **employee\_id** `string` *required*
>
> BambooHR employee ID whose photo is to be fetched
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Hiring Leads
>
> **Slug:** `BAMBOOHR_GET_HIRING_LEADS`
>
> Tool 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job Summaries
>
> **Slug:** `BAMBOOHR_GET_JOB_SUMMARIES`
>
> Retrieve ATS job opening summaries, optionally filtered by status group and sorted. The authenticated caller must have access to ATS settings.
>
> #### Input Parameters
>
> **sortBy** `string ("created" | "status" | "title")`
>
> Field to sort by. Possible values: created, status, title
>
> **sortOrder** `string ("ASC" | "DESC")`
>
> Sort order, either ASC or DESC
>
> **statusGroups** `string ("ALL" | "DRAFT_AND_OPEN" | "DRAFT" | "OPEN" | "CLOSED")`
>
> Filter jobs by status group. Possible values: ALL, DRAFT\_AND\_OPEN, DRAFT, OPEN, CLOSED
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Departments Metadata
>
> **Slug:** `BAMBOOHR_GET_META_DEPARTMENTS`
>
> Tool to list department metadata. Use after needing all available department codes and names.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (non-negative)
>
> **offset** `integer`
>
> Number of results to skip before returning items (non-negative)
>
> **name\_contains** `string`
>
> Case-insensitive substring that the department name must contain
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Meta Divisions
>
> **Slug:** `BAMBOOHR_GET_META_DIVISIONS`
>
> Tool to list all division metadata. Use after authenticating to fetch the account's divisions.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (non-negative)
>
> **offset** `integer`
>
> Number of results to skip before returning items (non-negative)
>
> **name\_contains** `string`
>
> Case-insensitive substring that the division name must contain
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employment Status Metadata
>
> **Slug:** `BAMBOOHR_GET_META_EMPLOYMENT_STATUSES`
>
> Tool to list all employment status metadata. Use when you need all defined employment statuses for the company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Meta Job Titles
>
> **Slug:** `BAMBOOHR_GET_META_JOB_TITLES`
>
> Tool to retrieve job title metadata. Uses the list-field metadata endpoint and extracts the options for the `jobTitle` field.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (non-negative)
>
> **offset** `integer`
>
> Number of results to skip before returning items (non-negative)
>
> **name\_contains** `string`
>
> Case-insensitive substring that the job title name must contain
>
> **include\_archived** `boolean`
>
> When false, exclude archived job titles from results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Meta Locations
>
> **Slug:** `BAMBOOHR_GET_META_LOCATIONS`
>
> Tool to list location metadata. Use when you need all configured company locations for lookups.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (non-negative)
>
> **offset** `integer`
>
> Number of results to skip before returning items (non-negative)
>
> **name\_contains** `string`
>
> Case-insensitive substring that the location name must contain
>
> **include\_archived** `boolean`
>
> When false, exclude archived locations from results
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time-Off Types Metadata
>
> **Slug:** `BAMBOOHR_GET_META_TIME_OFF_TYPES`
>
> Tool to list time-off type metadata. Use when you need to discover available time-off types before creating time-off requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Report
>
> **Slug:** `BAMBOOHR_GET_REPORT`
>
> Tool 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
>
> **fd** `string ("yes" | "no")`
>
> Apply duplicate field filtering: 'yes' or 'no'
>
> **format** `string ("CSV" | "PDF" | "XLS" | "XML" | "JSON")`
>
> Output format of the report
>
> **report\_id** `string` *required*
>
> ID of the report to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time-Off Balances
>
> **Slug:** `BAMBOOHR_GET_TIME_OFF_BALANCES`
>
> Retrieve 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
>
> **end\_date** `string`
>
> End date (YYYY-MM-DD) to estimate balances as of.
>
> **employee\_ids** `array`
>
> Optional list of employee IDs to filter balances for.
>
> **max\_employees** `integer`
>
> Maximum number of employees to fetch balances for. Limits API calls to avoid timeouts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time-Off Policies
>
> **Slug:** `BAMBOOHR_GET_TIME_OFF_POLICIES`
>
> List time-off policies, with accrual and rollover details when available. A 404 response is returned as an empty policy list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Time-Off Requests
>
> **Slug:** `BAMBOOHR_GET_TIME_OFF_REQUESTS`
>
> Tool 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
>
> **id** `string`
>
> Limit results to a specific request ID
>
> **end** `string` *required*
>
> Only show time off on or before this date, format YYYY-MM-DD
>
> **type** `string`
>
> Comma-separated list of time off type IDs to include
>
> **start** `string` *required*
>
> Only show time off on or after this date, format YYYY-MM-DD
>
> **action** `string ("view" | "approve")`
>
> Filter by access level; legal values: view, approve
>
> **status** `string`
>
> Comma-separated list of request statuses; legal values: approved, denied, superseded, requested, canceled
>
> **employeeId** `string`
>
> Limit results to a specific employee ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Reports
>
> **Slug:** `BAMBOOHR_LIST_BUILTIN_REPORTS`
>
> Lists a page of saved custom reports available in the account. Requires the report OAuth scope or an API key with report access permissions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Country Options
>
> **Slug:** `BAMBOOHR_META_GET_COUNTRIES`
>
> Retrieve BambooHR country options for use when updating or validating country fields.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return (non-negative)
>
> **offset** `integer`
>
> Number of results to skip before returning items (non-negative)
>
> **name\_contains** `string`
>
> Case-insensitive substring that the country name must contain
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get List Field Details
>
> **Slug:** `BAMBOOHR_META_GET_LIST_FIELD_DETAILS`
>
> Tool to get details for all list fields. Use when you need to discover list field options before using them.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Tabular Fields Metadata
>
> **Slug:** `BAMBOOHR_META_GET_TABULAR_FIELDS`
>
> Tool to list tabular table fields metadata. Use when you need standard table structures before accessing table rows.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Users
>
> **Slug:** `BAMBOOHR_META_GET_USERS`
>
> List company users with basic information, including IDs, names, email addresses, and account status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Employee
>
> **Slug:** `BAMBOOHR_UPDATE_EMPLOYEE`
>
> Tool 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
>
> **fields** `object` *required*
>
> Key/value pairs of employee fields to update, using BambooHR API field names.
>
> **employee\_id** `string` *required*
>
> The BambooHR employee ID to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Time Off Request
>
> **Slug:** `BAMBOOHR_UPDATE_TIME_OFF_REQUEST`
>
> Tool 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
>
> **note** `string`
>
> Optional note to include with the status change
>
> **status** `string ("approved" | "denied" | "canceled")` *required*
>
> New status for the time-off request
>
> **request\_id** `string` *required*
>
> ID of the time-off request to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
