BambooHR integration

Get a clock entry

Retrieves a specific clock entry for an employee from the bamboohr time tracking system. this endpoint allows you to fetch detailed information about a single clock-in or clock-out record, including timestamps and any associated metadata. use this when you need to review or verify a particular time entry for an employee, such as for payroll processing, attendance verification, or dispute resolution. the endpoint provides access to historical time tracking data, but it does not allow modification of existing entries or creation of new ones. note that the accessibility of clock entries may be subject to company-specific permissions and retention policies.

Get a company benefit

Retrieves detailed information about a specific company benefit offered by an organization using bamboohr. this endpoint allows hr administrators or integrated systems to fetch comprehensive data about a particular benefit, such as health insurance plans, retirement options, or other employee perks. it's useful for reviewing benefit details, verifying information, or displaying benefit specifics to employees. the endpoint requires the company's bamboohr subdomain and the unique identifier of the benefit, ensuring accurate and targeted data retrieval. note that this endpoint only provides information about the benefit itself and does not include employee enrollment data or personal information.

Get a daily entry

Retrieves a specific daily time tracking entry for an employee in bamboohr. this endpoint allows you to fetch detailed information about a single day's time tracking record, including clock-in and clock-out times, total hours worked, and any associated metadata. it's particularly useful when you need to review or verify an employee's time entry for a specific date. the endpoint requires the company domain, employee id, and the unique identifier of the daily entry to ensure accurate and secure data retrieval. use this endpoint when you need to access or display detailed time tracking information for auditing, payroll processing, or employee time management purposes.

Get aggregate goal info

Retrieves aggregated performance data for a specific employee's goal within the bamboohr system. this endpoint allows users to fetch consolidated information about a particular goal, providing insights into the employee's progress and performance related to that objective. it should be used when detailed aggregate data about a specific goal is needed, such as for performance reviews, goal tracking, or progress reporting. the endpoint focuses solely on individual goal data and does not provide company-wide or team-level aggregates. note that the specific aggregated metrics returned may vary based on the goal type and settings within your bamboohr environment.

Get a list of company benefits

Retrieves a comprehensive list of company-wide benefits offered by the organization as configured in bamboohr. this endpoint provides details about various benefit programs such as health insurance plans, retirement options, paid time off policies, and other perks available to employees. it's particularly useful for hr managers and system integrators who need to access or sync the company's benefit information across different platforms. the endpoint should be used when you need an overview of all benefits at the company level, rather than benefits assigned to specific employees. note that this endpoint does not provide individual employee enrollment information or personalized benefit details.

Get a list of company benefit types

Retrieves a list of company benefit types available in the specified bamboohr company account. this endpoint allows hr administrators and integrated systems to fetch information about the various benefit categories or types that the company offers to its employees. it's useful for populating dropdown menus in benefits enrollment forms, generating reports on benefit offerings, or syncing benefit type data with other hr systems. the endpoint provides a comprehensive view of the benefit structure within the organization but does not include details about specific benefit plans or employee enrollments.

Get a list of employee benefits

Retrieves employee benefit information based on specified filters. this endpoint allows hr professionals and benefit administrators to query and access employee benefit data using various criteria such as employee id, company benefit plan id, or enrollment status effective date. it is particularly useful for tasks like auditing benefit enrollments, managing open enrollment periods, or generating reports on benefit plan participation. the endpoint requires at least one filter to be specified and can combine multiple filters for more precise queries. it should be used when specific employee benefit information is needed, rather than for bulk data retrieval. note that this endpoint only provides filter-based access to benefit data and does not support creating, updating, or deleting benefit information.

Get a list of fields

Retrieves metadata about available fields in the bamboohr api for a specific company. this endpoint provides essential information about the structure and attributes of employee data that can be accessed or manipulated through other api calls. it should be used when you need to understand the available fields, their data types, and any constraints or formatting requirements. this information is crucial for constructing accurate queries or updates to employee records. the endpoint does not return actual employee data; it only provides metadata about the fields themselves.

Get a list of tabular fields

Retrieves metadata information about the tables available in the bamboohr system for a specific company. this endpoint is essential for developers and integrators who need to understand the structure of the bamboohr data model. it provides details about the available tables, which can be used to plan data retrieval, reporting, and integration strategies. the metadata likely includes table names, field names, and potentially data types or other structural information. this tool should be used when initializing a new integration or when updates to the bamboohr system might have changed the data structure. it's particularly useful for dynamic integrations that need to adapt to changes in the bamboohr schema. note that this endpoint doesn't return the actual data within the tables, only their structural information.

Get a list of users

Retrieves metadata about users within a specific company's bamboohr instance. this endpoint is useful for obtaining information about all users in the system, which can be valuable for user management, reporting, and integration purposes. it provides a comprehensive list of users and their associated metadata, allowing for efficient bulk retrieval of user information. this endpoint should be used when you need to gather data about multiple users simultaneously or when you require an up-to-date list of all users in the bamboohr system for a given company.

Get a list of who s out

Retrieves a list of employees who are currently out of office or on leave within your organization. this endpoint is part of bamboohr's time off management feature and provides real-time information about employee absences. use this endpoint to get an overview of current staff availability, which can be helpful for resource planning, scheduling, or maintaining an up-to-date company-wide calendar. the endpoint returns data for all types of absences, including vacation, sick leave, and other approved time-off categories. note that this endpoint only provides current "who's out" information and does not offer historical or future absence data.

Get all aggregate goal info

Retrieves aggregated goal information for a specific employee within a company's bamboohr system. this endpoint provides a comprehensive overview of an employee's goals, including a list of all goals, goal type counts, and goal comment counts. it's particularly useful for managers or hr professionals who need a quick summary of an employee's performance objectives and progress. the tool should be used when a high-level view of an employee's goal-related activities is required, such as during performance reviews or goal-setting sessions. it does not provide detailed information about individual goals or allow for goal modifications.

Add a benefit group employee

This endpoint allows you to associate an employee with a specific benefit group in bamboohr for a defined period. it's used when you need to enroll an employee in a new benefits package or update their existing benefits enrollment. the association can be set for a specific time frame or left open-ended for ongoing enrollment. this tool is particularly useful for hr administrators managing employee benefits, especially during onboarding, annual enrollment periods, or when an employee's benefit status changes. note that this endpoint only creates the association; it doesn't provide details about the benefits themselves or handle the actual enrollment process in specific benefit plans.

Add an employee benefit

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.

Add an employee dependent

This endpoint allows you to create a new dependent for an existing employee in the bamboohr system. it is used to add family members or other individuals who are dependent on the employee, which is crucial for benefits administration, tax purposes, and other hr-related tasks. the endpoint requires detailed information about the dependent, including personal details, contact information, and status indicators. it should be used when onboarding new employees with dependents, updating family information, or managing benefits enrollment periods. note that some fields contain sensitive personal information, so ensure proper data security measures are in place when using this endpoint.

Add an employee s default withholdings

This endpoint updates an employee's withholding information for tax purposes in the bamboohr system. it allows modification of federal, state, and local tax withholding amounts, including any additional withholdings, as well as specifying the applicable tax state and local jurisdiction. this tool should be used when there are changes to an employee's tax situation, such as filing status changes, additional jobs, or relocation. it's crucial for maintaining accurate payroll calculations and tax compliance. the endpoint doesn't calculate tax amounts; it only updates the stored values based on the provided information. users should ensure they have the correct withholding information before making updates, as incorrect data may lead to under or over-withholding of taxes.

Add an employee s direct deposit information

Updates the direct deposit account information for a specific employee in the bamboohr system. this endpoint allows you to modify existing direct deposit accounts or add new ones for an employee. it's particularly useful when an employee changes their bank account, adjusts their deposit allocations, or wants to split their paycheck across multiple accounts. the endpoint requires the company domain and employee id in the url path, and accepts an array of account objects in the request body, each detailing the specifics of a direct deposit account. this tool should be used with caution as it directly affects an employee's payment method, and any errors could result in payroll issues.

Add an employee s paystub

Creates a new employee pay stub in the bamboohr system. this endpoint allows for the detailed recording of an employee's pay information for a specific pay period, including gross and net pay, taxes, deductions, and direct deposit allocations. it should be used when processing payroll to maintain accurate financial records for each employee. the endpoint captures both current pay period data and year-to-date totals, providing a comprehensive view of an employee's earnings and deductions. it's particularly useful for integrating external payroll systems with bamboohr, ensuring that hr records are synchronized with actual payroll data. note that this endpoint does not process actual payments; it only records the pay stub information in the bamboohr system.

Add an employee s unpaid paystubs

Posts unpaid pay stubs for a specific employee in the bamboohr system. this endpoint allows you to add or update information about pay periods for which an employee has not been paid. it's useful for tracking delayed payments, managing payroll discrepancies, or recording periods of unpaid leave. the function requires the employee's id and an array of unpaid period dates. use this when you need to update an employee's payroll record with periods that haven't been compensated yet. note that this endpoint doesn't process payments; it only records the unpaid periods for tracking and future processing.

Add a new company benefit

This endpoint creates a new company benefit in bamboohr. it allows hr administrators to set up various types of employee benefits, including health insurance, retirement plans, and reimbursement programs. the endpoint captures essential details such as benefit type, start and end dates, deduction information, and compliance with aca requirements. use this endpoint when adding a new benefit offering or updating an existing benefit with new terms. it's particularly useful during open enrollment periods or when changing benefit providers. note that this endpoint does not enroll employees in the benefit; it only sets up the benefit at the company level.

Add an hour record

This endpoint allows you to add a new time tracking record for an employee in the bamboohr system. it's used to log hours worked, including regular and overtime hours, along with associated details such as pay rates, job codes, and organizational information. the endpoint is essential for accurate time tracking, payroll processing, and reporting within bamboohr. use this when you need to manually input or programmatically add time entries for employees, ensuring that all required fields are provided and optional fields are included as needed for your specific payroll and reporting requirements.

Add application comment

This endpoint allows you to post a comment on a specific application in bamboohr's applicant tracking system. it's used to add notes, feedback, or any relevant information to an applicant's file during the recruitment process. the endpoint requires the company domain and application id to identify where the comment should be added, along with the comment text itself. it's particularly useful for collaboration among hiring team members, documenting interview feedback, or noting important details about an applicant. this function should be used whenever there's a need to update an application with new information in a comment format. note that this endpoint only handles adding comments and does not provide functionality for reading or modifying existing comments.

Add a time off history item for time off request

Adds a new time off history item to an employee's record in bamboohr. this endpoint is used to retroactively add time off requests to an employee's history, which is useful for maintaining accurate records of past time off, especially when backfilling data or correcting historical entries. it allows hr administrators to ensure that an employee's time off history is complete and up-to-date, which is crucial for accurate leave balance calculations and reporting. the endpoint requires the company domain and employee id to be specified in the url path, ensuring that the time off history item is added to the correct employee's record.

Add a time off request

This endpoint allows you to add or update a time off request for a specific employee in bamboohr. it's used to submit new time off requests or modify existing ones, providing detailed information about the request such as start and end dates, type of time off, and any associated notes. this tool is essential for managing employee leave and maintaining accurate records of time off within the bamboohr system. it should be used whenever an employee needs to request time off or when hr needs to update an existing time off request. the endpoint doesn't handle approval workflows directly; it's primarily for creating and updating request data.