BambooHR is an American technology company that provides human resources software as a service.
Tools
Create New Employee
Creates a new employee record in the bamboohr system. this endpoint allows you to add a new employee to your company's hr database by providing essential information such as first name and last name. it's typically used when onboarding new hires or adding existing employees to the bamboohr system for the first time. the endpoint supports additional properties beyond the required fields, allowing for flexible and comprehensive employee data entry. however, it's important to note that this endpoint only initiates the employee record and may not include all possible employee information fields available in bamboohr.
Get Employee By Id
Retrieves detailed information for a specific employee within a company's bamboohr system. this endpoint allows you to fetch comprehensive employee data using the employee's unique identifier. it's particularly useful when you need to access or display individual employee records, update employee information, or verify employee details. the endpoint returns all available fields for the employee, which may include personal information, job details, compensation data, and custom fields configured for the company. use this endpoint when you need specific, up-to-date information about a single employee. note that the exact fields returned may vary based on the company's bamboohr configuration and the permissions of the authenticated user making the request.
Fetch Employee Directory
Retrieves the employee directory for a specified bamboohr company. this endpoint provides a list of employees within the company, including basic information such as names, job titles, and departments. it's useful for getting an overview of the company's workforce or for integrating employee data into other systems. the endpoint should be used when you need a comprehensive list of employees, but it may not include detailed information about each employee. for more specific or detailed employee data, consider using custom reports or individual employee endpoints instead. keep in mind that the amount and type of information returned may depend on the user's permissions within the bamboohr system.
Update Employee Information Via Id
Updates an employee's basic information in the bamboohr system. this endpoint allows you to modify an employee's first name and/or last name. it should be used when there's a need to correct or change an employee's name in the hr records, such as in cases of marriage, divorce, or legal name changes. the endpoint accepts partial updates, meaning you can update either the first name, last name, or both. any additional properties sent in the request will also be accepted due to the 'additionalproperties: true' setting, but their behavior is not specified in this schema. it's important to note that this endpoint only updates name information and should not be used for modifying other employee data such as contact details or job information.
Update Employee Table Row
This endpoint allows you to update a specific row in an employee's table within bamboohr. it is used to modify various aspects of an employee's record, such as their job information, location, or organizational structure. the endpoint is particularly useful for keeping employee data up-to-date when changes occur, such as promotions, transfers, or organizational restructuring. it's important to note that this endpoint updates a single row in a specific table, so multiple calls may be necessary for comprehensive employee record updates across different tables.
Create Employee Benefit Entry
Creates or updates an employee benefit in the bamboohr system. this endpoint allows you to manage various aspects of an employee's benefit enrollment, including coverage details, financial contributions, and enrollment status. it's primarily used when setting up new benefits for an employee, making changes to existing benefits, or updating enrollment statuses. the endpoint is versatile, handling different types of benefits with various contribution structures for both employees and the company. it's important to note that while many fields are optional, they may be required depending on the specific benefit type and company policies. this endpoint should not be used for bulk updates or to retrieve benefit information; separate endpoints likely exist for those purposes.