com.mcparmory/bamboohr

Retrieves a list of job opening summaries from the Applicant Tracking System. Supports filtering by status group or specific status IDs, with configurable sorting. Requires ATS settings access.

Retrieves all list fields defined in the account, including each field's ID, alias, options, manageability, and multi-value support. Archived options are included in responses to support historical data references but should not be presented as active selections.

Retrieves benefit enrollment events for all employees and their dependents over the past year, organized by member. Each entry identifies a member and lists their per-plan coverage events (eligibility granted, enrolled, or loss of coverage) in chronological order. Requires benefit settings access.

Retrieves a paginated list of benefit enrollment records for all members (employees and dependents) in the company for a specified calendar year, including each member's plans and enrollment status date ranges. Requires benefit admin privileges; non-admin callers receive a 403.

Retrieves all tabular (table-based) fields available in the account, including each table's alias and its fields with their IDs, names, and types. Use this to discover valid table names and field metadata required for table row endpoints such as jobInfo, compensation, and employmentStatus.

Retrieves all active time off policies for the company, sorted alphabetically by name. Excludes deleted policies and any policies whose associated time off type has been deleted.

Retrieves time off requests that overlap a specified date range, requiring both a start and end date. Results can be filtered by request ID, employee, time off type, status, or scoped to requests the caller is authorized to approve.

Retrieves all active time off types for the company, along with the company's default hours-per-day schedule. Optionally filter to only the types the authenticated employee has permission to request.

Retrieves timesheet entries (clock and hour types) for all employees or a filtered subset within a specified date range. Both dates must fall within the last 365 days and are interpreted in the company timezone.

Retrieves a paginated list of available timezones. Supports pagination, filtering, sorting, and field projection via OData v4 query parameters.

Retrieves all training categories defined for the company, returned as an object keyed by category ID with each entry containing the category ID and name. Requires the API key owner to have access to training settings.

Retrieves all training types configured for the company, returned as an object keyed by training type ID. Each entry includes the training name, renewable status, renewal frequency, required status, new hire due-date window, category, link URL, description, and self-completion permission. Requires the API key owner to have access to training settings.

Retrieves all users for the company, with each record including user ID, employee ID, name, email, account status, and last login time. Support admin accounts are always excluded; results can be filtered by status and returned as JSON or XML based on the Accept header.

Retrieves recent delivery log entries for a specific webhook, covering the last 14 days and up to 200 entries. Each entry includes the webhook URL, last attempt and success timestamps (UTC datetime or status string), HTTP response code, payload format, and employee IDs in the payload. Note: when the rate limit is exceeded the server returns HTTP 200 with an error object instead of the log array — callers must check for an `error.code` of 429 in the response body before processing results.

Retrieves all employee fields available for webhook monitoring, including each field's numeric ID, human-readable name, and alias. Use the returned field IDs or aliases when specifying the `monitorFields` array during webhook creation or updates.

Retrieves all available employee fields that can be included in a webhook post body, along with their related table and page record references. Use the returned field IDs or aliases in the `postFields` map when creating or updating a webhook.

Retrieves all webhooks associated with the authenticated API key, returning an empty array if none exist. Each result includes the webhook ID, name, URL, creation datetime, and last fired datetime; use get_webhook to fetch full configuration details for a specific webhook.

Returns a date-sorted list of employees who are out and company holidays for a specified date range. Includes both time off entries and holidays, each identified by type, defaulting to today through the next 14 days when no dates are provided.

Retrieve paginated records from a specified dataset by providing a list of fields to return, with optional filtering, sorting, grouping, and aggregation. Use GET /api/v1/datasets/{datasetName}/fields to discover available field names before calling this endpoint.

Reopens a previously closed goal for the specified employee, returning it to in-progress status. Returns the updated goal object reflecting the new status.

Performs a full replacement of a break policy and all its associated data, including breaks and employee assignments. Any breaks or assignments not included in the request payload will be removed from the policy.

Replaces the complete set of breaks for a specified break policy. Breaks with an ID are updated, breaks without an ID are created, and any existing breaks omitted from the request are soft-deleted.

Replaces the complete list of employees a goal is shared with, overwriting any previous sharing configuration. The goal owner's employee ID must be included in the updated list.

Removes specific employees from a break policy assignment without affecting the policy itself or other assigned employees. Only applicable to policies that are not configured to apply to all employees.

Updates the status of a specific applicant tracking application. The API key owner must have ATS settings access, and valid status IDs can be retrieved via the Get Applicant Statuses endpoint.

Partially updates an existing time tracking break by its UUID, modifying only the fields provided in the request body. Returns the full updated break record on success.

Partially updates an existing break policy by its UUID, modifying only the fields provided in the request body. Returns the full updated break policy on success.

Updates metadata for an existing company file, including its display name, category, and employee visibility. Only fields included in the request body are modified; omitted fields remain unchanged.

Fully replaces an existing employee dependent record with the provided data. This is a full-replacement operation — all fields must be supplied, as omitted fields will be cleared rather than preserved.

Update one or more fields for an existing employee by submitting a JSON object or XML document with field name/value pairs. To discover all available field names beyond those listed here, call the list_fields operation (GET /api/v1/meta/fields). Note: if the employee is on a Trax Payroll pay schedule, a comprehensive set of required payroll fields must be included in the request.

Updates metadata for an existing employee file, supporting renaming, category reassignment, and toggling employee visibility. Only fields included in the request body are modified; omitted fields remain unchanged.

Updates an existing row in a specified employee table by submitting one or more field name/value pairs to modify. Targets a specific row by ID within tables such as job information or compensation history.

Updates an existing row in a specified employee table, such as job information or compensation history. Submit field changes to modify the row's effective date, location, department, job title, reporting structure, or team assignments.

Updates the text of an existing comment on a specific employee goal. The comment, goal, and employee must all be correctly associated for the update to succeed.

Updates the completion percentage of a specific employee goal, optionally recording the completion date when the goal is fully achieved.

Updates an existing performance goal for a specified employee, including support for adding, modifying, or deleting milestones within the goal. Use this version (v1.1) instead of v1 when milestone management is required.

Create, update, or archive options for a specific list field by its ID. Omit an option's ID to create it, include an ID to update it, or set archived to yes to hide it from future use while preserving historical data.

Updates the completion status of a specific milestone within an employee's goal. Use this to mark a milestone as complete or incomplete as part of tracking goal progress.

Updates an existing time tracking entry identified by its unique ID. Use this to correct hours worked or reassign the entry to a different project, task, shift differential, or holiday.

Approves, denies, or cancels an existing time off request by updating its status. Owners and admins can complete all workflow approval steps at once, while standard approvers advance only their current step.

Updates the name of an existing training category identified by its ID. Requires training settings access; returns a 409 conflict if a category with the new name already exists.

Updates an existing employee training record by its ID. The completion date is required; all other fields such as cost, instructor, hours, credits, and notes are optional.

Updates an existing training type by modifying only the fields provided in the request. Requires training settings access; pass an empty string or null for the category field to remove a category assignment.

Uploads a file to a specific section of an employee's document folder via multipart/form-data. Files must be under 20MB and use a supported extension; on success, the response includes a Location header pointing to the newly created file resource.

Uploads and replaces the photo for a specified employee, updating all size variants. The image must be a square JPEG, PNG, or BMP file of at least 150×150 pixels and no larger than 20MB; employees may upload their own photo if the company has self-photo uploads enabled.

Uploads a file to a specified company file category using a multipart/form-data request. Files must be under 20MB, use a supported extension, and cannot be uploaded to read-only categories or implementation categories on companies that have completed implementation.

Bulk create or update time tracking hour records in a single request. Note that HTTP 201 may be returned even when individual records fail validation — always inspect each item's `success` flag and `response.message` for partial failures.