Bamboohr

This endpoint allows you to adjust existing time tracking records in bamboohr. it is used to update the number of hours worked for a specific time entry, identified by its unique time tracking id. this tool is particularly useful for correcting errors in time logs, adjusting hours after the fact, or updating time records based on new information. the endpoint requires both the time tracking id and the new total hours worked, ensuring accurate and targeted updates to employee time records. it’s important to note that this endpoint updates the total hours worked, not the difference from the original value.

Action Parameters

Action Response

This endpoint clocks out an employee in the bamboohr time tracking system, marking the end of their working hours. it should be used when an employee finishes their work shift or needs to record the end of their working time. the endpoint is part of the time tracking api, which integrates with bamboohr timesheets for comprehensive time management. it’s important to note that this endpoint only records the clock-out time and doesn’t provide additional information about the employee’s shift or total hours worked. ensure that the employee is currently clocked in before using this endpoint, as attempting to clock out an employee who isn’t clocked in may result in an error.

Action Parameters

Action Response

Retrieves the available filters for an employee’s performance goals in bamboohr. this endpoint is used to fetch a list of filters that can be applied when querying or managing an employee’s goals. these filters may include criteria such as goal status, goal type, time frame, or other relevant categorizations specific to the company’s performance management system. the retrieved filters can be used to refine subsequent api calls related to employee goals, allowing for more targeted and efficient data retrieval or updates. this endpoint is particularly useful when building interfaces or reports that require dynamic filtering options for employee goals.

Action Parameters

Action Response

This endpoint updates a specific row in an employee’s table within bamboohr. it modifies various aspects of employee information, such as job details or organizational assignment. use it to keep employee records current when changes occur in employment status, job role, or structure. specify company domain, employee id, table name, and row id. partial updates are supported.

Action Parameters

Action Response

Updates the photo for a specific employee in the bamboohr system. this endpoint allows you to upload a new profile picture for an employee, enhancing their digital presence within the hr platform. it should be used when there’s a need to refresh an employee’s photo, such as after a company-wide headshot update or when onboarding a new employee. the endpoint accepts image data (not specified in the schema, but likely in the request body) and associates it with the given employee id. note that this endpoint only updates the photo and does not affect other employee profile information. ensure the image meets any size or format requirements specified by bamboohr to avoid upload issues.

Action Parameters

Action Response

Retrieves detailed pay stub information for a specific employee within a company’s bamboohr system. this endpoint allows hr professionals or authorized personnel to access an individual employee’s pay details, including earnings, deductions, and net pay for a particular pay period. it’s particularly useful for payroll verification, addressing employee inquiries about their compensation, or generating reports. the endpoint should be used when specific, detailed pay information is needed for an individual employee. it does not provide aggregate payroll data or modify any information. note that access to this sensitive data is likely to be restricted to users with appropriate permissions within the bamboohr system.

Action Parameters

Action Response

Retrieves detailed information about a specific webhook registered in the bamboohr system. this endpoint allows you to fetch the configuration and settings of an existing webhook using its unique identifier. use this endpoint when you need to review or verify the details of a particular webhook, such as its target url, subscribed events, or current status. it’s particularly useful for troubleshooting webhook-related issues or auditing your webhook configurations. the endpoint does not modify any webhook settings; it’s a read-only operation.

Action Parameters

Action Response

This endpoint records a clock-in event for a specific employee in the bamboohr time tracking system. it allows for precise tracking of work hours, including the start time, associated project and task, and optionally, the location of the clock-in. this tool should be used when an employee begins their work day or returns from a break. it’s particularly useful for organizations that need detailed time tracking, especially those with remote or field workers. the endpoint doesn’t handle clock-out events or provide any information about ongoing or completed work periods.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of hiring leads from the bamboohr applicant tracking system (ats) for a specified company. this endpoint allows users to access information about individuals responsible for various aspects of the hiring process, such as recruiters, hiring managers, or interviewers. it should be used when you need to gather data on the personnel involved in recruitment activities within your organization. the endpoint provides an overview of hiring leads but may not include detailed information about ongoing recruitment processes or candidate data. note that the specific fields returned in the response are not detailed in the given schema and may vary based on the company’s configuration and permissions.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves an employee’s photo from the bamboohr system in a specified size. this endpoint is used to fetch visual representations of employees, which can be useful for directories, profiles, or other hr-related applications that require employee images. the tool allows for flexibility in photo size, enabling developers to retrieve appropriately sized images for different use cases, such as thumbnails or full-size profile pictures. it should be used when an application needs to display or process an employee’s photo. note that the availability and quality of photos depend on what has been uploaded to the bamboohr system for each employee.

Action Parameters

Action Response

The addwebhook endpoint allows you to create a new webhook in bamboohr, enabling real-time notifications for specific employee data changes. this tool is used to set up automated data synchronization between bamboohr and external systems, triggered by changes to monitored fields. it provides granular control over which data is sent, how often, and in what format. use this when you need to integrate bamboohr with other systems or automate workflows based on hr data changes. note that webhooks are subject to rate limiting and security constraints, so careful configuration is essential to ensure reliable and secure data transmission.

Action Parameters

Action Response

This endpoint deletes a specific row from an employee’s table in bamboohr. it allows for the removal of individual entries from structured data sets associated with an employee, such as job history, education records, or certifications. the endpoint should be used when there’s a need to remove incorrect or outdated information from an employee’s record. it’s important to note that this operation is irreversible, so it should be used with caution. this endpoint does not return the deleted data or provide a confirmation of deletion in its response, so additional verification may be necessary after calling this endpoint.

Action Parameters

Action Response

This endpoint allows you to upload a file to an employee’s record in bamboohr. it’s used when you need to attach documents such as contracts, certificates, or any other relevant files to a specific employee’s profile. the endpoint accepts a file upload, likely through a multipart form data request, and associates it with the specified employee. this function is particularly useful for maintaining comprehensive employee records, ensuring all relevant documents are centralized and easily accessible within the bamboohr system. note that the file size and type limitations are not specified in the schema and may be subject to bamboohr’s general file upload constraints.

Action Parameters

Action Response

This endpoint records the clock-out time for a specific employee in the bamboohr time tracking system. it should be used when an employee ends their work shift or workday. the endpoint requires the company domain, employee id, and the exact clock-out time. it supports specifying a timezone, which is particularly useful for companies with employees working across different geographical locations. this function is crucial for accurate time tracking, payroll processing, and compliance with labor regulations. note that this endpoint only records the clock-out event; it does not provide information about the total hours worked or any other time tracking data.

Action Parameters

Action Response

This endpoint allows you to post a comment on a specific employee’s goal within the bamboohr performance management system. it’s used to provide feedback, updates, or additional information related to an employee’s progress on a particular goal. the endpoint is particularly useful for managers, hr professionals, or team members who need to collaborate and communicate about goal achievement. when using this endpoint, ensure you have the necessary permissions to comment on the specified employee’s goals. the comment will be immediately visible to users with access to the employee’s performance records in bamboohr.

Action Parameters

Action Response

This endpoint allows you to create a new training record for a specific employee in the bamboohr system. it’s used to document completed training sessions, including details such as the completion date, cost, instructor, duration, credits earned, and any additional notes. this tool is essential for maintaining accurate employee development records, tracking professional growth, and ensuring compliance with training requirements. it should be used whenever an employee completes a training session, workshop, or course that needs to be officially recorded in their hr file. the endpoint requires the company domain and employee id as part of the url, ensuring that the training record is associated with the correct employee in the appropriate company account.

Action Parameters

Action Response

This endpoint deletes a specific goal associated with an employee in the bamboohr performance management system. it should be used when a goal is no longer relevant, has been completed, or needs to be removed from an employee’s record. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for maintaining up-to-date and relevant goal records, especially during performance review cycles or when organizational objectives change. it does not return any data upon successful deletion, and it’s important to note that it will not affect any historical performance data or completed goal achievements that may be associated with the deleted goal.

Action Parameters

Action Response

The clockoutemployee endpoint allows you to record an employee’s clock-out time and location in the bamboohr time tracking system. this endpoint should be used when an employee finishes their work session and needs to log their end time and current location. it captures precise geolocation data along with a readable address to ensure accurate time and location tracking for payroll, compliance, and workforce management purposes. this tool is particularly useful for remote or field workers who need to clock out from various locations.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Clocks in an employee in the bamboohr time tracking system, marking the start of their work period. this endpoint should be used when an employee begins their work shift or returns from a break. it allows for optional association with specific projects and tasks, as well as the addition of a note for context. the function is particularly useful for remote workers or companies with flexible working hours. it does not provide clock-out functionality or retrieve existing time entries - separate endpoints would be required for those actions.

Action Parameters

Action Response

Deletes a specific employee training record from the bamboohr system. this endpoint is used to permanently remove a training record associated with an employee, such as completed courses, certifications, or professional development activities. it should be used when a training record needs to be removed due to errors, duplications, or when it’s no longer relevant. caution should be exercised when using this endpoint, as the deletion is irreversible and may affect reporting or compliance tracking. ensure proper authorization and verification before deleting any records.

Action Parameters

Action Response

Retrieves timesheet entries for a specific company in bamboohr. this endpoint is part of the time tracking feature and provides detailed information about employee time entries, including total hours worked, holiday and time off hours, clock in and out times, projects, tasks, and notes. it’s primarily used for payroll processing, workforce management, and generating time-related reports. the endpoint should be used when you need to access comprehensive time tracking data for all employees or when preparing for payroll runs. it does not provide real-time clock-in/out status and may have limitations on the date range for which data can be retrieved in a single call.

Action Parameters

Action Response

Deletes multiple time tracking hour entries from the bamboohr system. this endpoint allows for bulk removal of hour entries, which is useful for correcting errors, removing duplicate entries, or cleaning up historical time tracking data. it should be used when you need to permanently remove specific hour entries from an employee’s time tracking record. be cautious when using this endpoint, as deleted entries cannot be recovered. this tool does not provide a way to retrieve or view the entries before deletion, so it’s recommended to verify the entries to be deleted using other endpoints before calling this one.

Action Parameters

Action Response

Deletes a specific employee pay stub from the bamboohr system. this endpoint should be used when there’s a need to remove an incorrect or outdated pay stub from an employee’s record. it permanently removes the pay stub data, so it should be used with caution and only when necessary, such as in cases of payroll errors or data cleanup. the operation cannot be undone, so it’s crucial to verify the correct pay stub id before deletion. this endpoint is particularly useful for maintaining accurate payroll records and ensuring compliance with financial regulations.

Action Parameters

Action Response

Retrieves a list of projects assigned to a specific employee within a company’s bamboohr account. this endpoint is part of the time tracking api and allows you to fetch project assignments for individual employees, which is essential for managing and tracking employee time across different projects. use this endpoint when you need to view or analyze an employee’s project allocations, plan resource distribution, or generate reports on employee project involvement. the endpoint returns only current project assignments and does not provide historical data or future planned assignments. it’s particularly useful for managers and hr professionals who need to oversee employee workloads and project distributions.

Action Parameters

Action Response

Retrieves a specific file associated with an employee from the bamboohr system. this endpoint allows you to access individual documents or files that have been uploaded to an employee’s record, such as resumes, contracts, or performance reviews. it should be used when you need to fetch a particular file for viewing, downloading, or processing. the endpoint requires precise identification of the company, employee, and file, ensuring secure and accurate retrieval of sensitive hr documents. it’s important to note that this endpoint only retrieves the file; it does not provide capabilities for uploading, modifying, or deleting files. access to files may be subject to user permissions within the bamboohr system.

Action Parameters

Action Response

Retrieves a list of locations associated with the applicant tracking system for a specific bamboohr company account. this endpoint is useful for obtaining information about the various locations or offices where job openings may be available or where applicants might be considered for placement. it can be used to populate location dropdown menus in job application forms or to filter job postings by location. the endpoint provides a comprehensive view of all locations configured in the company’s applicant tracking system, which is particularly valuable for organizations with multiple office locations or those offering remote work options. note that this endpoint only returns location data and does not provide any information about specific job openings or applicants associated with these locations.

Action Parameters

Action Response

Updates a specific row in a table associated with an employee’s record in bamboohr. this endpoint allows for modifying various attributes of an employee’s data, such as job information, location, or other custom fields, depending on the table being updated. it’s particularly useful for recording changes in an employee’s status, position, or other job-related information over time. the endpoint should be used when there’s a need to update existing information in an employee’s record, rather than adding new entries. it’s important to note that this endpoint updates an existing row and does not create new ones. the specific fields available for update may vary depending on the table being modified and your bamboohr configuration.

Action Parameters

Action Response

Deletes a specific company benefit from the bamboohr system. this endpoint should be used when you need to remove a benefit that is no longer offered or relevant to the company. it permanently removes the benefit from the system, so it should be used with caution. once deleted, the benefit cannot be recovered, and any employees associated with this benefit may need to be updated. this operation may have implications for reporting and historical data, so it’s recommended to archive or document the benefit details before deletion if needed for record-keeping purposes.

Action Parameters

Action Response

Retrieves the available filters for an employee’s performance goals in bamboohr. this endpoint is used to fetch a list of filter options that can be applied when querying or managing an employee’s goals within the performance management system. it provides the necessary parameters to narrow down goal-related data, such as by goal type, status, or time frame. this tool is particularly useful when preparing to search or analyze an employee’s goals, as it allows you to understand the available filtering options before making more specific goal-related api calls.

Action Parameters

Action Response

This endpoint allows you to view a specific file associated with an employee in the bamboohr system. it retrieves the file’s content and metadata, enabling you to access important employee documents such as contracts, performance reviews, or any other files stored in the employee’s profile. use this endpoint when you need to fetch and display the contents of an employee’s file, such as during employee reviews, audits, or when updating employee records. the endpoint is read-only and does not modify any data. note that while the endpoint doesn’t explicitly specify which file to view, it’s likely that an additional identifier for the specific file is required, either as part of the path or through a separate api call. also, be aware that access to employee files may be restricted based on user permissions within bamboohr.

Action Parameters

Action Response

Retrieves detailed information about a specific employee deduction within a bamboohr company account. this endpoint allows hr professionals and authorized personnel to access individual deduction records, which may include details such as the deduction type, amount, frequency, and associated employee. it’s particularly useful for verifying deduction details, auditing payroll information, or gathering data for financial reporting. the endpoint should be used when specific deduction information is needed, rather than for bulk data retrieval. note that this endpoint provides read-only access to deduction data and cannot be used to modify existing deductions or create new ones.

Action Parameters

Action Response

Retrieves the log entries for a specific webhook in a company’s bamboohr instance. this endpoint is used to access the history of events triggered by the webhook, providing valuable information for monitoring and troubleshooting integrations. it’s particularly useful for developers who need to verify that webhooks are functioning correctly or investigate any issues with event delivery. the log typically includes details such as timestamps, event types, and delivery statuses for each webhook trigger. this tool should be used when detailed information about a webhook’s activity is required, but it does not provide real-time notifications or allow modification of the webhook itself.

Action Parameters

Action Response

The closeemployeegoal endpoint allows you to mark a specific performance goal as completed or closed for an individual employee in bamboohr. this action is typically used when an employee has achieved their goal or when the goal period has ended. the endpoint provides the option to include a final comment, which can be useful for summarizing the outcome or providing context for the goal closure. it’s important to note that this action is irreversible, so it should be used carefully and only when you’re certain that the goal should be finalized. this endpoint is particularly useful for maintaining up-to-date performance records and facilitating performance review processes within the bamboohr system.

Action Parameters

Action Response

This endpoint allows you to adjust the time off balance for a specific employee in bamboohr. it’s used to make corrections, add or subtract time off, or reconcile discrepancies in an employee’s time off records. the adjustment is applied to a particular time off type (e.g., vacation, sick leave) on a specified date. this tool is particularly useful for hr administrators who need to manually modify time off balances due to policy changes, corrections, or special circumstances. it provides a way to maintain accurate time off records without altering the underlying accrual rules or past time off requests. note that this adjustment will be reflected in the employee’s time off history and may affect future balance calculations.

Action Parameters

Action Response

Retrieves a list of time tracking projects assigned to a specific employee within a bamboohr company environment. this endpoint is used to fetch project data that an employee can log time against, supporting efficient time tracking and project management. it’s particularly useful for integrations that need to display or process an employee’s available projects for time entry. the endpoint should be called when initializing time entry interfaces or updating project lists for a given employee. note that this endpoint only provides project information and does not include actual time entries or project details beyond what’s necessary for time tracking purposes.

Action Parameters

Action Response

Retrieves a list of all webhooks configured for a specific company in bamboohr. this endpoint allows you to view the current webhook subscriptions, providing information about the events being monitored and the target urls where notifications are sent. use this endpoint when you need to audit existing webhooks, verify webhook configurations, or prepare for updating or deleting webhooks. it’s particularly useful for maintaining and troubleshooting integrations that rely on real-time data from bamboohr. note that this endpoint only lists webhooks; it does not provide details about individual webhook events or allow for webhook creation or modification.

Action Parameters

Action Response

Updates an existing company file in bamboohr, allowing modifications to the file’s metadata such as name, category, and employee sharing permissions. this endpoint is used when you need to change details of a file already uploaded to the bamboohr system, without replacing the file content itself. it’s particularly useful for reorganizing files, updating file names for better clarity, or adjusting file visibility to employees. the endpoint doesn’t support uploading new file content; it’s strictly for updating file metadata. ensure you have the correct file id and company domain before making the request, as these are crucial for targeting the right file in the correct bamboohr instance.

Action Parameters

Action Response

Retrieves the costs associated with benefit group plans for a specific company in bamboohr. this endpoint provides detailed financial information about employee benefit plans, including premiums, contributions, and other related expenses. it is particularly useful for hr managers and finance teams who need to analyze and manage benefit costs across different employee groups. the endpoint should be used when you need to review or report on the current cost structure of your company’s benefit plans. it does not modify any data and is intended for read-only operations. note that the response may not include historical cost data or future projections, focusing instead on current cost information.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates an existing training type in the bamboohr system. this endpoint allows you to modify various attributes of a training type, including its name, description, frequency, category, and other properties. it’s used when you need to change the details of an existing training program or adjust its settings. the endpoint requires the company domain and the specific training type id in the url path. it’s important to note that while some fields are optional, the ‘name’ and ‘required’ fields must always be provided in the update request. this tool is particularly useful for hr managers and administrators who need to keep training information up-to-date or make changes to training requirements and settings.

Action Parameters

Action Response

Retrieves detailed information about a specific job application from bamboohr’s applicant tracking system. this endpoint allows you to access comprehensive data related to a single application, including applicant details, application status, and any custom fields associated with the application process. it’s particularly useful when you need to review or process individual applications, such as during candidate evaluation or interview scheduling. the endpoint provides a snapshot of the application at the time of the request, reflecting the most current information available in the system. note that this endpoint is read-only and does not allow modification of application data.

Action Parameters

Action Response

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.

Action Parameters

Action Response

This endpoint updates an existing employee goal with milestones in the bamboohr performance management system. it allows for comprehensive modification of goal details, including title, description, alignment, shared employees, due date, and associated milestones. the endpoint is particularly useful for adjusting goals as circumstances change or for adding more detailed tracking through milestones. it’s important to note that any non-required field not provided in the request will overwrite existing data with a null value, potentially resulting in unintended data loss. this endpoint should be used carefully to ensure all necessary information is included in each update to maintain the integrity of the goal data.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves comments associated with a specific goal for a particular employee within a company’s bamboohr environment. this endpoint is useful for tracking feedback, progress updates, and discussions related to employee performance goals. it provides valuable insights into the ongoing communication and evaluation process surrounding individual employee objectives. the tool should be used when detailed information about goal-related comments is needed, such as during performance reviews, goal assessments, or when monitoring employee progress. it does not modify any data and is intended for read-only access to existing comments. note that this endpoint only returns comments for a single goal at a time and does not provide information about the goal itself or other aspects of employee performance.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Creates a new training category in the bamboohr system. this endpoint allows hr administrators to organize and structure their training programs by adding custom categories. use this when you need to introduce a new classification for training content, courses, or programs. the newly created category can then be used to group related training materials, making it easier for employees and managers to navigate and access specific types of training. this endpoint is essential for maintaining an organized and efficient training management system within bamboohr.

Action Parameters

Action Response

Retrieves detailed information about benefit plan coverages for employees within a specific bamboohr company environment. this endpoint provides comprehensive data on various benefits and coverages offered by the company, such as health insurance, retirement plans, and other employee benefits. it should be used when you need to access or review the current benefit plans and coverage details for employees. the endpoint is particularly useful for hr administrators, benefits coordinators, or integration systems that need to synchronize benefit information with other platforms. note that this endpoint only provides read access to the benefit plan coverage data and cannot be used to modify or update this information.

Action Parameters

Action Response

The addorupdatedailytimeentries endpoint allows you to create new or update existing daily time entries for employees in the bamboohr time tracking system. it accepts an array of time entry objects, enabling bulk operations in a single request. this tool is ideal for efficiently managing multiple time entries, such as importing time data or updating entries after payroll review. it handles both adding new entries and updating existing ones based on the ‘dailyentryid’ parameter.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the list of employees with whom a specific performance goal is shared in bamboohr. this endpoint allows you to modify the visibility of an employee’s goal by specifying which other employees should have access to it. it’s useful for managing goal transparency and collaboration within the organization. the endpoint automatically includes all goal owners in the sharing list, so they don’t need to be explicitly specified. use this when you need to change who can view or interact with a particular employee’s performance goal.

Action Parameters

Action Response

Retrieves metadata about reference lists available in a company’s bamboohr instance. this endpoint provides essential information about predefined lists used across various bamboohr operations, such as employee statuses, departments, or job titles. it’s particularly useful for understanding the structure and available options within your bamboohr setup, which can be crucial for data integration, reporting, or building custom applications that interact with bamboohr data. the endpoint returns a comprehensive overview of all available lists, their purposes, and potentially their contents, allowing developers to efficiently work with standardized data sets within the bamboohr ecosystem. use this endpoint when you need to explore or validate the available options for fields that rely on predefined lists in your bamboohr instance.

Action Parameters

Action Response

Retrieves the time off calculator information for a specific employee in bamboohr. this endpoint is used to access details about an employee’s time off balances, accruals, and other related metrics. it’s particularly useful for hr managers or employees themselves to check current leave balances or plan future time off requests. the calculator may include information such as available vacation days, sick leave, or other types of time off specific to the company’s policies. this endpoint should be used when there’s a need to programmatically access up-to-date time off information for an individual employee, which can be helpful for integrating with other systems or generating reports. note that the exact details returned may vary based on the company’s bamboohr configuration and time off policies.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves metadata about time off policies for a specific company in the bamboohr system. this endpoint provides access to information about various types of time off policies configured for the company, such as vacation, sick leave, or personal time. it’s useful for obtaining an overview of all available time off policies, their settings, and any associated rules or accrual information. the endpoint should be used when there’s a need to review or audit the company’s time off policy structure, or when integrating time off management with other systems. note that this endpoint only provides policy information and does not include individual employee time off balances or requests.

Action Parameters

Action Response

Updates the status of a specific application in the bamboohr applicant tracking system. this endpoint allows you to change the current status of an application, which is useful for tracking the progress of candidates through your hiring process. use this when you need to move an application to a new stage, such as from ‘new’ to ‘under review’ or ‘interviewed’ to ‘offer extended’. the status is represented by an integer id, which corresponds to predefined status options in your bamboohr setup. it’s important to note that this endpoint only updates the status and doesn’t provide additional information about the application or candidate. ensure you have the correct status id before making the call, as incorrect ids may lead to unexpected status changes.

Action Parameters

Action Response

Deletes multiple clock entries from the bamboohr time tracking system. this endpoint allows administrators or authorized users to remove specific time clock entries identified by their unique ids. it should be used when there’s a need to correct errors, remove duplicate entries, or manage outdated records in bulk. the endpoint processes the deletion of all specified entries in a single request, improving efficiency for large-scale time tracking data management. however, it’s important to note that this action is irreversible, and deleted clock entries cannot be recovered through the api.

Action Parameters

Action Response

Retrieves the withholding information for a specific employee within a company’s bamboohr system. this endpoint allows hr professionals and authorized personnel to access tax withholding details, which are crucial for payroll processing and tax reporting. it provides up-to-date information on an employee’s tax withholding status, including federal, state, and local tax elections. use this endpoint when you need to review or verify an employee’s current withholding information, such as during payroll runs, annual reviews, or when an employee requests changes to their withholding. the endpoint returns only the most recent withholding data and does not provide historical information or the ability to modify withholding details.

Action Parameters

Action Response

Deletes a specific training type from the bamboohr system. this endpoint is used to permanently remove a training category that is no longer needed or was created in error. it should be used with caution as the deletion is irreversible and may affect related training records. the endpoint requires the company’s bamboohr subdomain and the unique identifier of the training type to be deleted. it’s important to note that this action might have cascading effects on employees’ training records or reports that reference the deleted training type.

Action Parameters

Action Response

Deletes a specific comment on an employee’s performance goal in the bamboohr system. this endpoint should be used when you need to remove feedback, notes, or other comments that are no longer relevant or appropriate for a particular goal. it’s particularly useful for maintaining clean and up-to-date goal tracking by removing outdated or incorrect information. the deletion is permanent, so use this endpoint with caution. it does not return any content upon successful deletion, only a success status code.

Action Parameters

Action Response

Retrieves the available goal alignment options for a specific employee or the authenticated api user in bamboohr. this endpoint is used to fetch possible alignment choices for employee goals, which helps in ensuring that individual objectives are in line with broader organizational goals. the response includes the currently aligned option for the employee’s goal, if one exists. this tool is particularly useful when setting up or adjusting employee performance goals, allowing for proper alignment with company objectives. it should be used when there’s a need to view or update the alignment of an employee’s goals within the performance management system. the endpoint does not modify any data; it only provides information about available alignment options.

Action Parameters

Action Response

The create clock entries endpoint allows you to add or update time tracking entries for employees in the bamboohr system. this endpoint is used to record work hours, including start and end times, for one or multiple employees in a single request. it’s particularly useful for bulk time entry creation or for updating existing entries. the endpoint accepts a json payload containing an array of entry objects, each representing a single clock entry with details such as employee id, date, start and end times, and optional information like project and task associations. use this endpoint when you need to log employee work hours, update existing time entries, or associate work time with specific projects and tasks. it’s important to note that this endpoint does not handle time-off requests or other types of absence management, which are typically handled by separate endpoints in the bamboohr api.

Action Parameters

Action Response

This endpoint creates a new job application in the bamboohr applicant tracking system. it allows for the submission of a candidate’s personal information, professional details, and supporting documents for a specific job opening. the endpoint accepts multipart/form-data, enabling the upload of resume and cover letter files along with text-based information. it should be used when a new candidate applies for a job or when bulk-uploading applications from external sources. the endpoint requires at minimum the candidate’s first name, last name, and the job id, but allows for a comprehensive application with optional fields covering everything from contact details to educational background.

Action Parameters

Action Response

Retrieves a list of benefit groups for a specific company in bamboohr. this endpoint allows you to access information about the various benefit groups set up within your organization, which can be crucial for managing employee benefits and understanding the structure of your company’s benefit offerings. it’s particularly useful when you need to review or audit the benefit groups available to employees, or when integrating benefit information with other hr systems. the endpoint doesn’t support creating, updating, or deleting benefit groups, nor does it allow for enrolling employees or changing benefit statuses. use this endpoint when you need a comprehensive overview of all benefit groups in your bamboohr instance.

Action Parameters

Action Response

Retrieves a list of benefit plans available for the specified company in bamboohr. this endpoint allows you to fetch comprehensive information about the various employee benefit plans offered by the organization, such as health insurance, retirement plans, and other perks. it should be used when you need to review or analyze the benefit offerings for a specific company within bamboohr. the endpoint provides a snapshot of current benefit plans and does not include historical data or employee enrollment information. keep in mind that the level of detail in the response may vary depending on the company’s configuration and data availability in bamboohr.

Action Parameters

Action Response

This endpoint checks whether a specific employee has the permission to create goals within the bamboohr performance management system. it is useful for determining user capabilities before attempting to create or modify goals, ensuring proper access control within the application. the endpoint should be used when setting up or managing goal-setting processes, or when building interfaces that dynamically adjust based on user permissions. it does not provide information about existing goals or other performance metrics, focusing solely on the create permission for goals.

Action Parameters

Action Response

Retrieves the training record for a specific employee within a bamboohr company account. this endpoint allows you to access detailed information about an employee’s training history, including completed courses, certifications, and other relevant training data. it should be used when you need to review or report on an individual employee’s training progress or compliance status. the endpoint does not provide aggregate training data for multiple employees or allow modifications to the training record. keep in mind that the response structure and specific fields returned may vary based on the company’s bamboohr configuration and the employee’s training history.

Action Parameters

Action Response

Retrieves specific timesheet data from the bamboohr time tracking system. this endpoint allows you to fetch detailed information for one or multiple timesheets by providing their unique ids. it’s particularly useful when you need to access time tracking records for specific employees or time periods. the endpoint should be used when you have the timesheet ids and require the associated time tracking data. it does not provide a way to search or filter timesheets; you must know the exact ids of the timesheets you want to retrieve. the response will include all available information for the requested timesheets, which can be used for reporting, payroll processing, or auditing purposes.

Action Parameters

Action Response

Retrieves a specific timesheet for a given employee within a bamboohr company environment. this endpoint allows you to fetch detailed time tracking information for a particular timesheet, identified by its unique id, associated with a specific employee. it’s useful for reviewing an employee’s work hours, verifying time entries, or gathering data for payroll processing. the endpoint should be used when you need to access or analyze individual timesheet data, rather than summary or aggregate time tracking information. note that this endpoint retrieves data for a single timesheet only; for bulk timesheet data or time tracking summaries, you may need to use different endpoints or make multiple calls.

Action Parameters

Action Response

Retrieves a list of applications submitted through the bamboohr applicant tracking system (ats). this endpoint allows hr personnel and recruiters to access and review all job applications in a centralized manner. it’s particularly useful for managing the hiring process, tracking candidate progress, and generating reports on recruitment activities. the endpoint returns detailed information about each application, which may include applicant details, applied position, application date, and current status. use this endpoint when you need to fetch application data for review, analysis, or integration with other hr systems. note that the response may be paginated for large datasets, and additional parameters for filtering or sorting may be available but are not specified in the given schema.

Action Parameters

Action Response

Creates a new job opening in the bamboohr applicant tracking system. this endpoint allows you to set up a comprehensive job listing with detailed information about the position, requirements, and application process. use this when you need to post a new job opportunity, whether it’s ready to be published or still in draft form. the endpoint captures essential job details and allows customization of the application form through various question fields. it’s particularly useful for hr managers and recruiters who need to efficiently manage the hiring process. note that while you can create a job opening, this endpoint does not automatically publish or advertise the position; additional steps may be required to make the job visible to potential applicants.

Action Parameters

Action Response

Retrieves the time off policies applicable to a specific employee within a bamboohr company. this endpoint allows you to fetch detailed information about the leave policies, including vacation days, sick leave, and other types of absences that are assigned to the employee. it’s particularly useful for hr systems integration, leave management applications, or when you need to display an employee’s available time off options. the endpoint returns policy details such as accrual rates, maximum balances, and any specific rules applied to the employee. use this when you need to understand an employee’s time off entitlements or to synchronize leave policy data with external systems. note that this endpoint only provides policy information and does not include the employee’s current leave balances or usage history.

Action Parameters

Action Response

Deletes multiple clock entries from the bamboohr time tracking system. this endpoint allows administrators to remove specific time tracking records, which is useful for correcting errors, managing outdated entries, or cleaning up the time tracking data. it should be used when you need to permanently remove one or more clock entries from an employee’s time tracking history. note that this operation is irreversible, so caution should be exercised when using this endpoint. the endpoint does not provide any confirmation or details about the deleted entries, so it’s recommended to verify the deletion through a separate get request if necessary.

Action Parameters

Action Response

Retrieves the list of employees with whom a specific employee’s goals can be shared within bamboohr. this endpoint is used to determine the visibility options for an employee’s performance goals, allowing hr managers or system administrators to view and potentially modify goal sharing settings. it’s particularly useful when setting up or reviewing goal visibility across the organization, ensuring appropriate access to performance information. the endpoint does not modify any data; it only provides information about current share options. it should be used when there’s a need to understand or audit the goal visibility for a particular employee.

Action Parameters

Action Response

Adds new values or updates existing values for a specific list field in the bamboohr system. this endpoint allows you to modify the available options for custom dropdown fields, multi-select fields, or other list-type fields in your bamboohr instance. it’s particularly useful when you need to maintain consistent list options across your hr system, such as updating department names, job titles, or any other predefined lists used in employee records or forms. the endpoint requires the company domain and the specific list field id to be included in the url path, ensuring changes are applied to the correct field in the right company instance.

Action Parameters

Action Response

Retrieves aggregated performance goal data for a specific employee within a company’s bamboohr system. this endpoint provides a comprehensive summary of an employee’s goals, potentially including metrics such as goal completion rates, progress status, and overall performance against set objectives. it’s particularly useful for managers and hr professionals who need a quick overview of an employee’s goal-related performance without diving into individual goal details. the aggregated data can be valuable for performance reviews, goal-setting sessions, or generating reports on employee progress. note that this endpoint focuses on summarized data and may not provide granular details about each individual goal.

Action Parameters

Action Response

This endpoint allows you to store or update multiple time tracking hour entries for employees in bamboohr. it’s designed for bulk creation or modification of timesheet entries, enabling efficient management of employee work hours, project time allocation, and task tracking. use this endpoint when you need to submit time entries for one or more employees, associate work hours with specific projects or tasks, or update existing time entries. the endpoint is particularly useful for integrating external time tracking systems with bamboohr or for automating the process of time entry submission. note that while you can create multiple entries in a single request, each entry must contain the required fields (employeeid, date, and hours) to be valid. optional fields allow for more detailed time tracking and management capabilities.

Action Parameters

Action Response

Retrieves a specific report from the bamboohr system for a given company. this endpoint allows users to fetch pre-configured reports containing various hr-related data such as employee information, company statistics, or custom reports created within the bamboohr platform. it is particularly useful for extracting structured data for analysis, reporting, or integration with other systems. the endpoint should be used when specific report data is needed, rather than raw data queries. note that the availability and content of reports depend on the company’s bamboohr configuration and permissions.

Action Parameters

Action Response

Updates an existing employee goal in the bamboohr system. this endpoint allows you to modify various aspects of an employee’s goal, including its title, description, progress, alignment, sharing, and key dates. it’s particularly useful for keeping goal information current as progress is made or when goal details need to be adjusted. the endpoint requires the company domain, employee id, and goal id to be specified in the url path. note that any non-required fields not provided in the request will overwrite existing data with null values, so include all relevant fields even if they haven’t changed. use this endpoint when you need to update goal information, track progress, or modify goal sharing and alignment within your organization.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates an existing file associated with a specific employee in the bamboohr system. this endpoint allows you to modify file properties such as the name, category, and sharing status. use this when you need to rename a file, move it to a different category, or change its visibility to the employee. it’s particularly useful for maintaining up-to-date and properly organized employee records. note that this endpoint doesn’t allow you to change the actual content of the file; it only updates the file’s metadata. to replace the file content, you would need to delete the existing file and upload a new one.

Action Parameters

Action Response

The updateemployeedependent endpoint allows you to modify the information of an existing employee dependent in the bamboohr system. this tool is used to update personal details, contact information, and other relevant data for an employee’s dependent, such as a spouse, child, or other family member. it’s particularly useful for maintaining accurate records for benefits administration, emergency contacts, and compliance purposes. the endpoint accepts a comprehensive set of fields, allowing for detailed updates to the dependent’s profile. however, it’s important to note that while many fields are provided, not all may be required for every update operation. use this endpoint when there are changes to a dependent’s information or when correcting existing data in the system.

Action Parameters

Action Response

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.

Action Parameters

Action Response

This endpoint allows an employee to clock in and record their work start time in the bamboohr time tracking system. it captures essential information such as the start time, timezone, and optionally, the project and task being worked on, as well as the precise geolocation of the clock-in event. this tool should be used when an employee begins their work shift or returns from a break. it’s particularly useful for businesses tracking remote work, field services, or requiring detailed time logs for project-based billing. the endpoint does not handle clock-out events directly; a separate call would be needed for that purpose.

Action Parameters

Action Response

Retrieves the performance goals for a specific employee within a company’s bamboohr account. this endpoint allows you to fetch the current set of goals associated with an individual employee, which may include both active and completed goals. it’s particularly useful for managers or hr professionals who need to review an employee’s objectives, track progress, or prepare for performance discussions. the endpoint should be used when you need to access detailed goal information for a single employee, such as during performance reviews, goal-setting sessions, or when generating reports on employee performance. note that this endpoint only provides goal data and does not include other performance metrics or feedback. the response will likely include details such as goal descriptions, target dates, current status, and any associated notes or updates.

Action Parameters

Action Response

Retrieves aggregated information about an employee’s goals within the bamboohr performance management system. this endpoint provides a summary of goal-related data for a specific employee, which may include metrics such as goal completion rates, progress status, or overall performance indicators. it’s particularly useful for managers or hr professionals who need a quick overview of an employee’s goal achievement without delving into individual goal details. the aggregated data can be valuable for performance reviews, progress tracking, or identifying areas where an employee may need additional support or recognition. note that this endpoint focuses on summarized data and may not provide exhaustive details about each individual goal.

Action Parameters

Action Response

Retrieves a list of all applicant tracking statuses for a specific bamboohr company. this endpoint is useful for getting an overview of the different stages in your company’s recruitment process. it can be used to populate dropdown menus in applicant tracking systems, generate reports on application statuses, or synchronize status information with other hr tools. the endpoint returns all available statuses, so there’s no need for pagination or filtering parameters. note that this endpoint only provides status information and does not include details about individual applicants or job postings.

Action Parameters

Action Response

Retrieves a specific time tracking record from bamboohr based on the provided company domain and record id. this endpoint allows you to fetch detailed information about a single time entry, including the employee, date, hours worked, and any associated metadata. it’s particularly useful for auditing time entries, generating reports, or displaying detailed time tracking information in custom interfaces. the endpoint should be used when you need to access or verify the details of a specific time tracking record. note that this endpoint only retrieves data and does not modify any existing records.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates an existing company benefit in the bamboohr system. this endpoint allows you to modify the details of a specific benefit offering, such as its name, type, dates, and various attributes. it’s used when changes need to be made to an existing benefit, such as extending the coverage period, updating the benefit description, or adjusting reimbursement details. the endpoint requires the company domain and the benefit id to identify the specific benefit to be updated. at minimum, the update must include the benefit name, start date, and type, even if these values remain unchanged. this endpoint should not be used to create new benefits or to delete existing ones.

Action Parameters

Action Response

Retrieves a list of employees associated with benefit groups within a specific bamboohr company instance. this endpoint is useful for hr administrators and systems integrators who need to access or audit employee benefit group assignments. it provides a comprehensive view of how employees are categorized for benefits purposes, which can be essential for managing enrollment periods, analyzing benefit distribution, or synchronizing data with other hr systems. the endpoint should be used when you need an up-to-date snapshot of benefit group memberships across the organization. note that this endpoint only provides read access and cannot be used to modify benefit group assignments. the returned data may include employee ids, names, and their associated benefit group information, but the exact structure of the response should be verified in the api documentation.

Action Parameters

Action Response

This endpoint allows you to clock out employees and approve their timesheets simultaneously in the bamboohr time tracking system. it’s designed for efficiently processing end-of-day or end-of-shift time entries for one or multiple employees. the endpoint accepts an array of clock out information, enabling bulk processing of timesheet approvals. it should be used when managers or hr personnel need to finalize time entries and approve timesheets in a single operation, streamlining the time tracking workflow. this endpoint is particularly useful for companies with shift-based work or those requiring daily timesheet approvals. note that this action is final and may require appropriate permissions to execute.

Action Parameters

Action Response

Retrieves a list of dependents for all employees in the company. this endpoint provides comprehensive information about employee dependents, which may include family members, beneficiaries, or other individuals associated with employees for hr purposes such as benefits administration or emergency contacts. it’s particularly useful for generating reports, updating benefits information, or performing company-wide dependent audits. the endpoint returns data for all employees, so it should be used cautiously and in compliance with data privacy regulations. note that this endpoint does not support filtering or pagination, so it may return a large amount of data for companies with many employees and dependents.

Action Parameters

Action Response

Retrieves detailed information about a specific employee’s dependent in bamboohr. this endpoint is used to fetch data such as the dependent’s name, relationship to the employee, date of birth, and other relevant details stored in the system. it’s particularly useful when you need to access or verify information about an employee’s family members or other dependents for benefits administration, emergency contact updates, or other hr-related tasks. the endpoint requires both the company’s unique domain and the specific dependent’s id to locate and return the correct information.

Action Parameters

Action Response

Retrieves a list of job postings from the company’s applicant tracking system (ats) in bamboohr. this endpoint provides access to all active job listings for the specified company, including details such as job titles, descriptions, and current status. it’s particularly useful for hr managers, recruiters, or integration systems that need to display or process the company’s current job openings. the endpoint returns comprehensive job data, allowing for easy synchronization with external job boards or internal systems. note that this endpoint likely returns all active jobs without pagination, so it may not be suitable for companies with an extremely large number of open positions.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves the current clock-in status for a specific employee within a company’s bamboohr environment. this endpoint allows you to quickly determine whether an employee is currently clocked in or out, which is useful for real-time attendance tracking and management. it should be used when you need to check an employee’s immediate work status, such as for timesheet verification or monitoring ongoing projects. the endpoint provides a simple boolean response, indicating only the current state, and does not offer historical data or clock-in/out times. this tool is particularly valuable for managers and hr professionals who need to monitor employee attendance or track time-sensitive tasks.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Deletes a specific file associated with an employee in the bamboohr system. this endpoint should be used when you need to permanently remove a document or file from an employee’s record. it’s particularly useful for maintaining data accuracy, complying with document retention policies, or removing outdated or incorrect files. the operation is irreversible, so caution should be exercised when using this endpoint. it does not provide any confirmation or retrieve the file content before deletion, so it’s advisable to verify the correct fileid before making the call.

Action Parameters

Action Response

This endpoint allows you to update the name of an existing training category in bamboohr. it is used when you need to modify the label or classification of a group of training programs or courses within your organization. the endpoint requires the company domain and the specific training category id to identify which category to update. you should use this when reorganizing your training structure or correcting category names. note that this endpoint only updates the name of the category and does not affect the training items associated with it. ensure you have the necessary permissions to modify training categories before using this endpoint.

Action Parameters

Action Response

Retrieves a list of available time off types for a specific company in bamboohr. this endpoint is used to fetch metadata about the various categories of time off that employees can request, such as vacation, sick leave, or personal days. it’s particularly useful when setting up or managing time off policies, or when integrating time off requests with other systems. the endpoint provides essential information for creating time off requests or reporting on time off usage across the organization. note that this endpoint only returns the types of time off available and does not provide information about individual employee time off balances or requests.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates a specific comment on an employee’s goal in bamboohr’s performance management system. this endpoint allows you to modify existing feedback or progress updates associated with a particular goal for an employee. it’s useful for correcting information, providing additional context, or updating the status of a goal. the endpoint requires the company domain, employee id, goal id, and comment id to precisely target the comment to be updated. the new comment content should be provided in the request body as a json string. this endpoint should be used when there’s a need to revise or expand on previously provided goal-related feedback. it does not create new comments or modify the goal itself, only the specified comment.

Action Parameters

Action Response

Retrieves specific table data for a given employee from a company’s bamboohr instance. this endpoint allows you to access structured information about an employee, such as job details, employment status, or custom fields, depending on the specified table. it’s particularly useful for integrations that need to pull specific categories of employee data for reporting, analysis, or synchronization with other systems. the endpoint requires the company’s bamboohr domain, the employee’s unique identifier, and the name of the table to be queried. note that the availability and content of tables may vary based on the company’s bamboohr configuration.

Action Parameters

Action Response

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.

Action Parameters

Action Response

The approvetimesheets endpoint enables managers or authorized personnel to approve multiple employee timesheets in a single api call within the bamboohr time tracking system. this function streamlines the timesheet approval process, which is a critical step in payroll processing and ensuring accurate compensation for employees. it should be used at the end of a pay period or when managers need to approve a batch of completed timesheets. the endpoint requires the last modification timestamp and an array of timesheet ids to be approved, allowing for efficient batch processing. however, it does not provide the ability to partially approve or reject individual time entries within a timesheet; the approval applies to the entire timesheet for each id provided.

Action Parameters

Action Response

Retrieves the benefit coverages information for employees within a specific company in bamboohr. this endpoint allows hr administrators and authorized personnel to access detailed data about the various benefit plans and coverage options available to employees. it provides a comprehensive overview of the company’s benefit offerings, which may include health insurance, dental plans, vision coverage, life insurance, and other employee benefits. use this endpoint when you need to review, audit, or report on the current benefit coverage landscape for the entire organization. the returned data can be useful for benefits administration, open enrollment planning, and ensuring compliance with company policies and regulations.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Creates a new training type in the bamboohr system with specified attributes and settings. this endpoint allows hr administrators to define and customize various aspects of a training program, including its name, description, renewal requirements, categorization, and completion settings. it’s particularly useful for setting up new employee training programs, compliance courses, or skill development modules within an organization. the endpoint provides flexibility in configuring how the training is presented, tracked, and managed within the bamboohr platform.

Action Parameters

Action Response

Retrieves the unpaid pay stubs for a specific employee within a company’s bamboohr account. this endpoint is used to access detailed information about an employee’s earnings that have not yet been paid out, which is crucial for payroll processing and financial record-keeping. it should be used when there’s a need to review or verify an employee’s pending compensation before the actual payment is made. the endpoint provides up-to-date information on unpaid wages, bonuses, or other forms of compensation, but does not include historical data for already paid stubs. it’s particularly useful for payroll administrators, finance teams, or integrated payroll systems that need to ensure accurate and timely payment processing.

Action Parameters

Action Response

Retrieves a specific employee file from the bamboohr system. this endpoint allows you to fetch individual documents or records associated with employees, such as contracts, performance reviews, or personal information forms. it should be used when you need to access or download a particular file for an employee. the endpoint requires the company’s bamboohr subdomain and the unique file identifier to locate and retrieve the correct file. note that this endpoint only retrieves the file content; it does not provide metadata about the file or list multiple files. ensure you have the necessary permissions to access the requested file, as bamboohr’s access controls may restrict file retrieval based on user roles.

Action Parameters

Action Response

This endpoint updates the status of a specific time-off request in bamboohr. it allows hr managers or authorized personnel to approve, deny, or cancel an employee’s time-off request. the endpoint is used when a decision has been made regarding a pending time-off request or when there’s a need to change the status of an existing request. it’s particularly useful for maintaining accurate records of employee leave and ensuring proper workflow in the time-off management process. the endpoint also provides the option to attach a note to the status change, allowing for clear communication and documentation of the decision-making process.

Action Parameters

Action Response

Retrieves a list of time off requests for a specific company in the bamboohr system. this endpoint allows hr administrators and authorized personnel to fetch and review all pending, approved, and denied time off requests across the organization. it’s particularly useful for managing employee leave, tracking time off balances, and ensuring proper staffing levels. the endpoint should be used when you need a comprehensive view of all time off requests or when integrating bamboohr’s time off management with other systems. note that this endpoint likely returns all time off requests without filtering, so additional processing may be required for specific date ranges or employee subsets.

Action Parameters

Action Response

Authenticates a user with the bamboohr system, initiating a session for subsequent api calls. this endpoint should be used as the first step when integrating with the bamboohr api, allowing access to protected resources and user-specific data. it requires the application key, user credentials, and is specific to each company’s domain. the login process is essential for maintaining security and tracking user actions within the bamboohr system. note that this endpoint does not provide any hr data directly; it only establishes authentication for further api usage.

Action Parameters

Action Response

The viewfile endpoint allows you to retrieve and view employee files stored in the bamboohr system. this get request is used to access specific documents or files associated with employees within your company’s bamboohr instance. it’s particularly useful for retrieving important employee documents such as contracts, performance reviews, or any other files stored in the system. the endpoint requires the company’s subdomain for identification and likely accepts additional query parameters (not specified in the schema) to identify the specific file to be viewed. use this endpoint when you need to access or display employee files directly through the api, enabling integration with document management systems or internal company portals.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Reopens a previously closed or completed goal for a specific employee in the bamboohr performance management system. this endpoint allows hr managers or authorized personnel to reactivate a goal that was marked as finished, enabling further updates or modifications to the goal. it’s particularly useful when goals need to be revisited due to changing circumstances, ongoing projects, or as part of a continuous performance review process. the endpoint requires the company’s domain, the employee’s id, and the specific goal id to be reopened. use this endpoint when you need to make a closed goal active again for tracking and evaluation purposes.

Action Parameters

Action Response

The “store time tracking clock entries” endpoint allows you to create or update multiple time tracking entries for employees in bamboohr. this endpoint is used to record working hours, including start and end times, dates, and optional project, task, and note information. it’s particularly useful for batch processing of time entries, such as at the end of a pay period or when synchronizing data from another system. use this endpoint when you need to add new time entries or modify existing ones in bulk. it supports creating new entries and updating existing ones by specifying the entry id. the endpoint is designed for efficiency, allowing multiple entries to be processed in a single api call. note that this endpoint does not handle time entry approval workflows or payroll calculations directly. it’s primarily for data entry and updates. ensure that the employee ids, project ids, and task ids used in the request correspond to valid entities in your bamboohr system to avoid errors.

Action Parameters

Action Response

Creates a custom report in bamboohr with specified parameters. this endpoint allows users to generate tailored reports by defining a title, applying filters, and selecting specific data fields to include. it’s particularly useful for extracting and analyzing employee data based on custom criteria. the report can include various employee attributes and can be filtered based on when the data was last changed. this tool should be used when detailed, customized employee data reports are needed, especially for data analysis, hr planning, or integration with other systems. note that the report generation might be asynchronous, and the actual report data may need to be retrieved separately.

Action Parameters

Action Response

Retrieves a comprehensive list of all deduction types configured in the bamboohr system for a specific company. this endpoint is crucial for benefits administrators and payroll managers who need to review or audit the various deduction categories set up in their bamboohr instance. it provides a complete overview of all possible deductions that can be applied to employee paychecks, such as health insurance premiums, retirement contributions, or other benefits-related deductions. this tool should be used when a full inventory of deduction types is required, for example, during benefit enrollment periods, payroll reconciliation, or when updating company-wide benefit policies. note that this endpoint does not provide individual employee deduction information, but rather the types of deductions available in the system.

Action Parameters

Action Response

This endpoint deletes a specific unpaid pay stub for an employee in the bamboohr system. it is used to remove outdated, erroneous, or unnecessary unpaid pay stub records from the company’s hr database. the operation is irreversible, so it should be used with caution. this endpoint is particularly useful for correcting payroll mistakes, managing test data, or cleaning up records during employee offboarding processes. it does not affect paid pay stubs or other employee financial records beyond the specified unpaid pay stub.

Action Parameters

Action Response

Updates a specific row in a custom table for an individual employee in bamboohr. this endpoint allows you to modify various aspects of an employee’s record, such as their job information, location, or organizational details. it’s particularly useful for keeping employee data current when there are changes in their role, department, or other key information. the endpoint should be used when there’s a need to update specific fields in a custom table that’s associated with an employee, rather than modifying their core profile. it’s important to note that this endpoint updates existing data and doesn’t create new entries. ensure that the table and employee id exist before making the call, as the endpoint doesn’t provide validation for non-existent records.

Action Parameters

Action Response

Retrieves a list of training types configured in the company’s bamboohr system. this endpoint allows developers to access and integrate training type information into their applications, supporting features such as employee development tracking, training program management, or reporting on learning initiatives. it’s particularly useful when building custom dashboards, generating training-related reports, or synchronizing training data with other systems. the endpoint provides a comprehensive view of the training categories or classifications used within the organization but does not return detailed information about specific training sessions or employee participation.

Action Parameters

Action Response

The deletewebhook endpoint is used to remove a specific webhook from the bamboohr system. this operation permanently deletes the webhook configuration, stopping any further notifications for the events it was set up to monitor. use this endpoint when you need to discontinue a particular integration or clean up unused webhooks to maintain an organized webhook structure. it’s important to note that this action cannot be undone, so it should be used with caution. the endpoint requires the company’s domain and the unique identifier of the webhook to ensure precise targeting of the webhook to be deleted.

Action Parameters

Action Response

Retrieves a list of employees whose records have been changed in the bamboohr system for a specific company. this endpoint is useful for syncing employee data with external systems or for auditing purposes. it allows you to efficiently track updates to employee information without querying all employee records. the endpoint returns only the identifiers of changed employees, not the actual changes, so you may need to make additional api calls to fetch the updated details. use this endpoint regularly to keep your systems in sync with bamboohr data. note that the specific time range for changes and the format of the response are not provided in the given schema and may require additional parameters or documentation.

Action Parameters

Action Response

Retrieves information about changes made to a specific table in the bamboohr system for a given company. this endpoint is useful for tracking updates and modifications to employee data or other hr-related information stored in bamboohr. it allows you to monitor changes in a particular table, helping maintain data integrity and auditing purposes. use this endpoint when you need to review recent changes, sync data with external systems, or generate reports on data modifications within a specific bamboohr table. the endpoint requires specifying both the company domain and the target table name to fetch the relevant change data.

Action Parameters

Action Response

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.

Action Parameters

Action Response

The deletetimetrackingentry endpoint allows for the deletion of a specific time tracking entry from the bamboohr system. this operation is used when you need to remove an individual time tracking record, such as an incorrectly entered time-off request or work hours log. the endpoint requires the company domain and the unique identifier of the time tracking entry to be deleted. it’s important to note that this operation is irreversible, so it should be used with caution. this endpoint is particularly useful for correcting errors in time tracking data or removing outdated entries, but it should not be used for bulk deletions or regular data management tasks.

Action Parameters

Action Response

Creates a new time tracking project in bamboohr. this endpoint allows you to set up a project with customizable settings such as billability, employee access, and associated tasks. use this when you need to establish a new project for tracking employee time, whether for client work or internal initiatives. the endpoint is particularly useful for project managers or hr administrators setting up new projects or initiatives that require time tracking. note that while you can create a project without tasks, adding tasks provides more granular time tracking capabilities.

Action Parameters

Action Response

Updates an existing webhook configuration in bamboohr. this endpoint allows you to modify various aspects of a webhook, including the monitored fields, data to be sent, frequency of updates, and rate limiting. use this when you need to change the behavior of an existing webhook, such as adjusting which employee data changes trigger notifications or modifying the format and content of the webhook payload. the endpoint provides fine-grained control over webhook behavior, enabling real-time integration with other systems based on specific bamboohr events. note that updating a webhook requires careful consideration of the receiving system’s capabilities and the potential impact on data flow between systems.

Action Parameters

Action Response

Deletes a specific file from the bamboohr system for a given company. this endpoint is used when you need to permanently remove a file from an employee’s records or the company’s document storage in bamboohr. it should be used with caution as the deletion is irreversible. the endpoint requires the company’s subdomain and the specific file id to identify and delete the correct file. it’s particularly useful for maintaining data hygiene, removing outdated or incorrect documents, or complying with data retention policies. note that this operation may be subject to user permissions within the bamboohr system, and successful deletion might depend on the file’s association with other records or processes.

Action Parameters

Action Response

This endpoint allows you to upload files to the bamboohr system for a specific company. it is used to add documents, such as employee records, contracts, or other hr-related files, to the company’s bamboohr account. the endpoint should be used when you need to programmatically add new files to the system or update existing documents. it’s important to note that this endpoint only handles the file upload process and does not provide functionality for retrieving or managing existing files. be aware that there may be limitations on file types and sizes that can be uploaded, although these are not specified in the given schema.

Action Parameters

Action Response

Retrieves a list of fields currently being monitored for webhook notifications in bamboohr. this endpoint is used to check which specific data points (such as employee information, time-off requests, or other hr-related activities) are set up for real-time notifications through webhooks. it’s particularly useful for developers integrating their applications with bamboohr to understand what changes they can track. the endpoint doesn’t modify any data; it only provides information about the current webhook monitoring configuration. note that this endpoint doesn’t set up new monitored fields; it only reports on existing ones.

Action Parameters

Action Response

The updateemployeetrainingrecord endpoint allows you to update an existing training record for a specific employee in the bamboohr system. this tool is used to modify details of a completed training, such as the completion date, cost, instructor information, duration, credits earned, and any additional notes. it’s particularly useful for keeping employee training records up-to-date and accurate, which is crucial for maintaining compliance and tracking professional development. the endpoint requires the company domain and the unique identifier of the training record to be updated, ensuring that the correct record is modified for the right employee within the organization.

Action Parameters

Action Response

Deletes a specific employee withholding record from the bamboohr system. this endpoint is used to remove tax deduction or other financial withholding information for an employee. it should be used when you need to permanently remove outdated, incorrect, or no longer applicable withholding data. this operation cannot be undone, so it should be used with caution. the endpoint requires the company’s bamboohr subdomain and the unique identifier of the withholding record to be deleted. it does not return any content upon successful deletion, typically responding with a 204 no content status.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of benefit group plans for a specified company in bamboohr. this endpoint is used to fetch information about the various benefit plans associated with different groups within the organization. it’s particularly useful for hr administrators and benefits managers who need to review or manage the benefit offerings across the company. the endpoint returns details about each benefit group plan, which may include plan names, coverage types, eligibility criteria, and other relevant information. use this endpoint when you need a comprehensive overview of the benefit structure within the company or when preparing for benefits enrollment periods. note that the specific details returned may vary based on the company’s configuration and the user’s access permissions within bamboohr.

Action Parameters

Action Response

Retrieves the time-off policies applicable to a specific employee within a bamboohr company account. this endpoint allows you to fetch detailed information about the time-off rules, accrual rates, and other policy specifics for an individual employee. it’s particularly useful for hr managers or systems that need to understand or display an employee’s current time-off entitlements and rules. the endpoint should be used when you need to review or verify an employee’s time-off policies, such as during leave requests or policy audits. it does not modify any data and is read-only. note that the response will only include policies relevant to the specified employee and may not provide a comprehensive list of all company-wide policies.

Action Parameters

Action Response

Retrieves detailed information about a specific payroll deduction by its id for a given company in bamboohr. this endpoint allows hr administrators and payroll managers to access comprehensive data about individual deductions, such as type, amount, frequency, and associated employee information. it’s particularly useful when reviewing or auditing payroll deductions, preparing reports, or addressing employee inquiries about specific deductions. the endpoint provides up-to-date information but does not allow modifications to the deduction data.

Action Parameters

Action Response

This endpoint allows you to add a new goal for a specific employee in the bamboohr performance management system. it’s used to create structured, trackable objectives that can be aligned with company strategies and shared among team members. the endpoint is particularly useful for setting up performance targets, professional development plans, or project-specific goals. it supports both simple goals and more complex objectives with multiple milestones, enabling detailed progress tracking and collaborative goal-setting within the organization.

Action Parameters

Action Response

Retrieves detailed information about a specific employee’s direct deposit account within a bamboohr company instance. this endpoint is used to access sensitive financial information, such as bank account details and routing numbers, associated with an employee’s payroll. it should be used when there’s a need to view or verify an employee’s direct deposit setup, such as during payroll processing or when an employee requests to confirm their banking information. the endpoint returns read-only data and does not allow modifications to the account information. it’s important to note that this endpoint should only be accessed by authorized personnel with appropriate permissions due to the sensitive nature of the data involved.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Deletes a specific training category from the bamboohr system for a given company. this endpoint should be used when you need to remove an obsolete or incorrect training category from the company’s hr records. it permanently removes the category and all associated data, so it should be used with caution. the operation cannot be undone, and any training records linked to this category may be affected. ensure you have the necessary permissions and have verified the category id before deletion.

Action Parameters

Action Response

Updates the progress of a specific employee’s goal in bamboohr. this endpoint allows you to modify the completion status of a goal assigned to an employee, helping track performance and achievement. it’s particularly useful for regular goal check-ins or when significant milestones are reached. the endpoint also considers goal sharing, as the description mentions that employee ids of those with whom the goal is shared are tracked. use this when you need to reflect the latest status of an employee’s progress towards their set objectives. note that this endpoint only updates the progress and doesn’t modify other aspects of the goal or provide additional goal details.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves all training categories for a specific company in bamboohr. this endpoint allows hr managers and administrators to access a comprehensive list of training categories set up within their organization’s bamboohr instance. it’s useful for getting an overview of the training structure, planning new training programs, or integrating training data with other systems. the endpoint returns all categories without filtering, making it ideal for populating dropdown menus or generating reports on the company’s training taxonomy. note that this endpoint only provides category information and does not include details about specific training sessions or employee participation.

Action Parameters

Action Response

Deletes a specific direct deposit account associated with an employee in the bamboohr system. this endpoint should be used when an employee’s direct deposit account needs to be removed, such as when an employee closes a bank account or requests removal of a direct deposit option. the deletion is permanent and cannot be undone, so it should be used with caution. this endpoint only removes the specified direct deposit account and does not affect other accounts or employee information.

Action Parameters

Action Response

Retrieves detailed information about a specific employee plan within a company’s bamboohr system. this endpoint allows hr professionals and authorized personnel to access individual plan details, which may include benefits information, compensation arrangements, or other work-related agreements. it’s particularly useful when reviewing or updating an employee’s plan, during performance evaluations, or when making changes to employee benefits. the endpoint requires the company’s unique domain identifier and the specific plan id to fetch the correct information. while it provides access to plan details, it does not allow modifications to the plan through this get request. for any changes or updates to the plan, a separate endpoint (likely a put or patch request) would be necessary.

Action Parameters