com.mcparmory/bamboohr

Retrieve paginated data for a specific saved custom report by its ID, using the report's stored field list and filter configuration. Use list_custom_reports to discover available report IDs.

Retrieves profile and field data for a specific employee by ID. Supports selective field retrieval and optionally includes future-dated values from historical tables such as job title or compensation.

Retrieves the full details of a single employee dependent by their unique dependent ID, including masked SSN/SIN values and full state and country names. Requires Benefits Administration permissions and returns data as a JSON or XML object containing a single-element array under the 'Employee Dependents' key.

Retrieves the company employee directory, including a fieldset definition and employee records. Access level determines the returned fieldset; directory sharing or org-chart access must be enabled for the company.

Retrieves a comprehensive aggregate of all goals for a given employee, including milestone-containing goals, type counts, filter actions, comment counts, and shared employee details. This version extends v1.1 by including goals that contain milestones.

Retrieves a JPEG photo of the specified employee at a predefined size. The response Content-Type is always image/jpeg, though the underlying byte payload may reflect the original upload format.

Retrieves time off balances for an employee across all assigned categories as of a specified date, incorporating accruals, adjustments, usage, and carry-over events. Pass today's date for current balances or a future date to project balances forward.

Retrieve the available filter values for one or more fields in a dataset, returning an object keyed by field name where each value is an array of id/value pairs. Use the returned id values when constructing filters for dataset queries.

Retrieve the available filter values for one or more fields in a dataset, returning an object keyed by field name where each value is an array of id/value pairs. Use the returned id values when constructing filters for dataset queries.

Retrieves a comprehensive goal detail view for a specific employee, including the goal's comments, alignment options, and a consolidated list of all persons who are shared on or have commented on the goal. Designed to populate a full goal detail view in a single request.

Retrieves the count of goals grouped by status for a specific employee, including goals that contain milestones. Use this to understand an employee's goal distribution across statuses before fetching detailed goal data.

Retrieves a single time tracking record by its unique ID, returning full details including hours, date, employee, project, task, and shift differential information. Note that project and shiftDifferential fields may be null when not applicable, and missing records may return an empty or null payload rather than a not-found error.

Retrieves the full configuration of a single webhook owned by the authenticated user, including its name, URL, format, monitored fields, events, and activity timestamps. Returns 403 if the webhook belongs to a different user and 404 if it does not exist.

Retrieves all applicant tracking statuses configured for the company, including both system-defined and custom statuses. Requires the API key owner to have access to ATS settings.

Retrieve a paginated list of job applications from the Applicant Tracking System (ATS). Supports filtering by job, application status, position status, and submission date, with flexible sorting options.

Retrieves all benefit coverage levels configured for the company, such as Employee Only, Employee + Spouse, or Employee + Family enrollment tiers. Returns each coverage level's ID, short name, description, sort order, and associated benefit plan ID (null for company-wide levels).

Retrieves all benefit deduction types available in the system, including categories such as 401(k), HSA, and Section 125, along with their allowable plan types, default deduction codes, and any sub-types. Requires Benefits Administration permissions.

Retrieves a paginated list of break assessments, each recording whether an employee complied with their assigned break policy for a given day along with any violations. Use the filter parameter to scope results by employee, date, compliance result, or other fields.

Retrieves a paginated list of all break policies configured in the time-tracking system. Optionally includes employee and break counts per policy for summary reporting.

Retrieves a paginated list of breaks associated with a specific break policy. Supports OData v4 filtering to narrow results by break attributes.

Retrieves the list of employees assigned to a specific break policy. Returns an empty list if no employees are currently assigned to the policy.

Retrieves table rows for all employees whose records have changed since a specified timestamp, grouped by employee ID. Any change to an employee record causes all of that employee's rows in the specified table to be returned, making this an efficient alternative to fetching full table data for all employees.

Retrieves a list of employee IDs that have changed since a specified timestamp, enabling efficient incremental sync without downloading all employee records. Each result includes the employee ID, change type (inserted, updated, or deleted), and the timestamp of the last change.

Retrieves all active (non-deleted) company benefit plans for the account, including summary-level details such as name, benefit category type, associated vendor and deduction IDs, effective date range, and catch-up eligibility flags. For full plan details including SSO URL, description, and ACA fields, use get_company_benefit with a specific plan ID.

Retrieves all company file categories and the files within each category that the requesting user has permission to view. Response format is controlled via the Accept header: use application/json for JSON or application/xml (or omit) for XML.

Retrieves the full list of countries supported by BambooHR, each including a numeric string ID, full name, and ISO 3166-1 alpha-2 code. The returned country IDs can be used with the Get States by Country ID endpoint to fetch corresponding states or provinces.

Retrieves the list of states or provinces for a given country, sorted alphabetically by abbreviation. Each result includes a numeric ID, abbreviation label, ISO 3166-2 code, and full name.

Retrieve a paginated list of saved custom reports available in the account, returning each report's ID and name. Use the returned report ID with the get_custom_report operation to fetch full report data.

Retrieves the available fields for a specified dataset, returning paginated field descriptors that include each field's machine-readable name, human-readable label, parent section type and name, and entity name. Use the returned field `name` values when constructing field selections in POST /api/v1/datasets/{datasetName} queries. Note: this endpoint is deprecated — prefer GET /api/v1_2/datasets/{datasetName}/fields.

Retrieve the available fields for a specified dataset, returning paginated field descriptors that include each field's machine-readable name, human-readable label, parent section, and entity name. Use the returned field `name` values when constructing data queries against the dataset.

Retrieves all available datasets, returning each dataset's machine-readable name and human-readable label. Use the returned names to query data via POST /api/v1/datasets/{datasetName} or discover fields via GET /api/v1/datasets/{datasetName}/fields. Note: this endpoint is deprecated — prefer GET /api/v1_2/datasets.

Retrieves all available datasets, returning each dataset's machine-readable name and human-readable label. Use the returned name values to query dataset records or discover available fields via related endpoints.

Retrieves current and future benefit enrollment records for one or more employees, grouped by employee, including plan details, enrollment status, deduction amounts, and cost-sharing information. At least one filter — employee ID, company benefit plan ID, or enrollment status effective date — must be provided.

Retrieves the available break options for a specific employee at a given point in time. Requires permission to view the target employee and time-tracking-break access.

Retrieves all break policies assigned to a specific employee. Requires permission to view the target employee's records.

Retrieves dependent records for one or all employees in the company, requiring Benefits Administration permissions. When an employee ID is provided the response is scoped to that employee; otherwise all dependents across the company are returned, with SSN/SIN values masked and state/country fields returned as full names.

Retrieves all available employee fields for the account, including field ID, display name, data type, and deprecation status. Use this to discover valid field names before querying employee data via the Get Employee, Datasets, or other field-based endpoints.

Retrieves the file categories and associated files visible to the caller for a specified employee. Results are permission-filtered; employees viewing their own profile also see files shared with them. Response format is determined by the Accept header (application/json for JSON, XML otherwise).

Retrieves the list of goals assigned to a specific employee, optionally filtered by goal status. Returns up to 50 goals in a `goals` array.

Retrieves all rows from a specified table for one or all employees, returning only the fields the caller has permission to access. Results are unordered and field visibility is subject to field-level permission checks.

Retrieves all time off policies currently assigned to a specified employee, including each policy's ID, time off type, and accrual start date.

Retrieves all time off policies currently assigned to a specified employee, including manual and unlimited policy types not available in the v1 endpoint.

Retrieves all training records for a specified employee, returned as an object keyed by training record ID. Optionally filter by training type; note that fields like instructor, credits, hours, and cost are only present when enabled in the company's training settings.

Retrieves a paginated list of employees, each including core identity and job fields by default, with optional filtering, sorting, and additional contact or social fields. Use the Get Employee endpoint or Datasets API for more comprehensive field coverage.

Retrieves the list of integration and feature identifiers currently enabled for the company. Each identifier is an uppercase string key representing an activated product feature or integration, reflecting the company's current subscription and configuration.

Retrieves the list of goals that a specified employee's goal can be aligned with. When a goal ID is provided, the currently aligned goal is included in the results even if it would otherwise be filtered out.

Retrieves all comments associated with a specific goal for a given employee. Useful for reviewing feedback, progress notes, and discussion threads tied to a performance goal.

Retrieves a list of employees with whom the specified employee's goals can be shared. Results are filtered by a search term matching name, employee ID, or email.

Retrieves the list of employees eligible to be assigned as a hiring lead on a job opening. Use the returned `employeeId` values as the `hiringLead` field when creating a new job opening via the Create Job Opening endpoint.

Retrieves all company locations available for use when creating a job opening in the Applicant Tracking System. Requires ATS settings access; use the returned location IDs as the `jobLocation` field when creating a job opening.