Connectors

HR & People

BambooHR

HR platform: employees, time off, benefits, and reporting data

BambooHR API referenceAPI checked August 16, 2026

Signs in with: Connection fields
Runs on: Cloud or On-Prem Worker
Operations: 302
Ready-made triggers: 0

Connect BambooHR

In Neblex open Connect › Connections and click New Connection.
Search for BambooHR and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

Field	What to enter
Company domainRequired	The subdomain in {company}.bamboohr.com.
API keyOptionalSecret	BambooHR API key, sent as the HTTP Basic username with password x.
OAuth access tokenOptionalSecret	OAuth 2.0 Bearer access token for OAuth-only or dual-auth routes.

Use it in a flow

Open a flow, open the node library and search for BambooHR.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from BambooHR without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if BambooHR can send webhooks, a Webhook trigger receives them at its own URL.

Operations

302 operations in 31 groups. Each one is a step you can add to a flow.

Account Information17

Get all currency types`getCurrencyTypes`	GET	Returns a JSON array of supported currency catalog entries.
Get All Provinces`getAllProvinces`	GET	Returns a flat list of all states and provinces across every country.
Get company properties`getCompanyProperties`	GET	Get company properties including ID, name, domain, and base API URL.
Get Countries`getCountries`	GET	Returns a JSON array of every country in the catalog, or a single country object when isoCode is supplied.
Get Country by ID`getCountry`	GET	Returns a single country from the catalog as a JSON object, identified by its numeric id.
Get Currency Conversion Rates`getCurrencyConversions`	GET	Returns the latest currency conversion rate snapshot for a single base currency.
Get timezone by ID`getTimezone`	GET	Retrieves a single timezone by its numeric ID.
Get timezone by ZIP code`getTimezoneByZip`	GET	Retrieves the timezone for a US ZIP code.
List Bank Holidays`listBankHolidays`	GET	Returns global bank holiday reference dates (US federal and related bank holidays maintained by BambooHR), not company-configured holidays.
List Fields`listFields`	GET	Returns a list of all employee fields available in the account, including field ID, display name, data type, and whether the field is deprecated.
List Industries`getIndustries`	GET	Returns every industry in BambooHR's reference data as a JSON array.
List List Fields`listListFields`	GET	Returns details for all list fields in the account.
List states and provinces for a country by Country ID`getProvincesByCountry`	GET	Returns the list of states or provinces for the specified country, sorted alphabetically by abbreviation (options[].label).
List Tabular Fields`listTabularFields`	GET	Returns a list of all tabular (table-based) fields available in the account.
List timezones`listTimezones`	GET	Retrieves a paginated list of timezones.
List Users`listUsers`	GET	Returns all users for the company, optionally filtered by status.
Update List Field Values`updateListFieldValues`	PUT	Create, update, or archive options for a list field.

Alerts5

Create Alert Configuration`createAlertConfiguration`	POST	Creates an alert configuration for the authenticated company from one of BambooHR's alert templates, and returns the stored configuration, including its server-assigned id, as a single...
Get Alert Configuration`getAlertConfiguration`	GET	Returns one alert configuration the company has set up: which alert template it uses, when it runs, who receives it, and any custom subject, message, or list-value filters.
List Alert Configurations`listAlertConfigurations`	GET	Returns every alert configuration the company has set up: which alert template each one uses, when it runs, who receives it, and any custom subject, message, or list-value filters.
List Alert Templates`listAlertTemplates`	GET	Returns the catalog of alert templates that company alert configurations are built from.
Replace Alert Configuration`updateAlertConfiguration`	PUT	Overwrites the alert configuration identified by {id} and returns the stored configuration as a single JSON object.

Applicant Tracking10

Create Candidate`createCandidate`	POST	Create a new candidate application for a job opening.
Create Job Application Comment`createApplicationComment`	POST	Add a comment to an application.
Create Job Opening`createJobOpening`	POST	Create a new job opening.
Get Applicant Statuses`listApplicantStatuses`	GET	Get a list of applicant statuses configured for the company.
Get Company Locations`listAtsLocations`	GET	Get all company locations available for use when creating a job opening.
Get Hiring Leads`listHiringLeads`	GET	Get the list of employees who can be assigned as a hiring lead when creating a new job opening.
Get Job Application Details`getJobApplication`	GET	Get the full details of a single application including applicant info, job details, questions and answers, and status history.
Get Job Applications`listJobApplications`	GET	Get a list of applications.
Get Job Summaries`listJobSummaries`	GET	Get a list of job opening summaries.
Update Applicant Status`updateApplicantStatus`	POST	Update the status of an application.

Benefits10

Create Employee Dependent`createDependent`	POST	Creates a new dependent record for an employee.
Get Employee Dependent`getDependent`	GET	Returns the details of a single employee dependent by their dependent ID.
List Benefit Coverages`listBenefitCoverages`	GET	Returns all benefit coverage levels configured in the company, such as Employee Only, Employee + Spouse, and Employee + Family.
List Benefit Deduction Types`listBenefitDeductionTypes`	GET	Returns all benefit deduction types available in the system.
List Company Benefits`listCompanyBenefits`	GET	Returns all active (non-deleted) company benefit plans for the account.
List Employee Benefits`listEmployeeBenefits`	GET	Returns current and scheduled-future benefit enrollment records, grouped by employee.
List Employee Dependents`listDependents`	GET	Returns employee dependents for the company.
List Member Benefit Events`listMemberBenefitEvents`	GET	Returns benefit enrollment events for all employees and their dependents over the past year, organized by member.
List Member Benefits`listMemberBenefits`	GET	Returns a paginated list of benefit enrollment records for all members (employees and dependents) in the company for a given calendar year.
Update Employee Dependent`updateDependent`	PUT	Replaces all fields on an existing employee dependent record.

Change Tracking2

Get Changed Employee IDs`getChangedEmployees`	GET	Returns a list of employee IDs that have changed since the given timestamp.
Get Changed Employee Table Data`getChangedTableData`	GET	Returns table data for employees that have changed since the given timestamp.

Company Files6

Create Company File Category`createCompanyFileCategory`	POST	Creates one or more company file categories.
Delete Company File`deleteCompanyFile`	DELETE	Permanently removes a company file and its associated storage.
Get Company File`getCompanyFile`	GET	Downloads a company file by its ID.
Get Company Files and Categories`listCompanyFiles`	GET	Returns all company file categories and the files within each category that the requesting user is permitted to see.
Update Company File`updateCompanyFile`	POST	Updates metadata for an existing company file.
Upload Company File`uploadCompanyFile`	POST	Uploads a file to a company file category.

Company Profile3

Get Company Profile Integrations`getCompanyProfileIntegrations`	GET	Returns the list of integration feature identifiers currently enabled for the company.
Update company display name`updateCompanyDisplayName`	PUT	Updates the company display name.
Update company information (phone, address, legal name)`updateCompanyInformation`	PATCH	Updates legal name, phone, and/or address for the company (application/merge-patch+json).

Compensation3

Get company equity settings`getEquitySettings`	GET	Retrieves company-level equity settings including calculation type, valuation, shares, pricing, and vesting-related configuration.
List available compensation tools`listCompensationTools`	GET	Returns the list of available compensation tools/settings for the company, including Levels & Bands, Compensation Benchmarking, Compensation Planning, and Total Rewards.
Update company equity settings`updateEquitySettings`	PUT	Updates company-level equity settings including calculation type, valuation, shares, pricing, and vesting-related configuration.

Compensation Benchmarking11

Create Compensation Benchmark`createBenchmark`	POST	Creates a new compensation benchmark for a specific company job title (and optionally a specific job location).
Create Compensation Benchmark Source`createBenchmarkSource`	POST	Creates a new benchmark source the company can attach to its benchmarks.
Delete Compensation Benchmark`deleteBenchmark`	DELETE	Permanently removes the compensation benchmark identified by id.
Delete Compensation Benchmark Source`deleteBenchmarkSource`	DELETE	Deletes a benchmark source together with all benchmarks currently attached to it.
Export Compensation Benchmark Details`exportBenchmarkDetails`	GET	Returns a CSV export of the compensation benchmark detail view for a single job, optionally scoped to a specific location.
Get Compensation Benchmark Details`getBenchmarkDetails`	GET	Returns detailed benchmark data for a single company job title, optionally scoped to a specific location.
Import Compensation Benchmarks From CSV`importBenchmarks`	POST	Parses a CSV of compensation benchmarks uploaded as multipart/form-data and returns the parsed rows together with a suggested column-to-field mapping.
List Compensation Benchmark Sources`listBenchmarkSources`	GET	Returns every enabled benchmark source configured for the company.
List Compensation Benchmarks`listBenchmarks`	GET	Returns every job/location pair the company tracks for compensation benchmarking.
Update Compensation Benchmark`updateBenchmark`	PUT	Updates an existing compensation benchmark identified by id.
Update Compensation Benchmark Sources`updateBenchmarkSources`	PUT	Updates the name and sort order of one or more existing benchmark sources in a single call.

Compensation Planning28

Add cycle admins`addCycleAdmins`	POST	Add one or more cycle admins by internal employee IDs.
Add employees to cycle`addCycleEmployees`	POST	Add employees to a compensation planning cycle.
Complete compensation planning cycle`completePlanningCycle`	PUT	Complete a compensation planning cycle and finalize employee compensation records.
Create compensation planning cycle`createPlanningCycle`	POST	Create a new compensation planning cycle with default settings.
Delete compensation planning cycle`deletePlanningCycle`	DELETE	Delete a compensation planning cycle.
Export compensation planning cycle worksheet to CSV`exportCycleWorksheet`	GET	Download compensation planning worksheet data as a UTF-8 CSV (Excel-friendly BOM).
Get change communication letter details`getChangeComm`	GET	Get change communication letter details for the compensation planning cycle.
Get compensation planning approval flows`getApprovalFlows`	GET	Get approval flows for the compensation planning cycle (grouped by department by default).
Get compensation planning cycle budgets`getCycleBudgets`	GET	Get budget guidelines and breakdown for the compensation planning cycle.
Get compensation planning cycle details`getPlanningCycle`	GET	Get compensation planning cycle details and currency settings for a cycle.
Get compensation planning cycle summary`getCycleSummary`	GET	Get compensation planning cycle summary (progress, stats).
Get compensation planning cycle worksheet`getCycleWorksheet`	GET	Get compensation planning worksheet details for the cycle (recommendations, approvals, or overview context).
Import budget breakdown`importBudgetBreakdown`	POST	Import budget breakdown from structured data and apply to allocations.
Launch compensation planning cycle`launchPlanningCycle`	PUT	Launch a compensation planning cycle.
List compensation planning cycle admins`listCycleAdmins`	GET	List compensation planning cycle admins.
List compensation planning cycles`listPlanningCycles`	GET	List all compensation planning cycles for the company, including status and employee counts.
List employees in compensation planning cycle`listCycleEmployees`	GET	List employees in the compensation planning cycle (picker data: company roster and membership).
Remove cycle admin`removeCycleAdmin`	DELETE	Remove a cycle admin by internal employee ID.
Remove employees from cycle`removeCycleEmployees`	DELETE	Remove employees from a compensation planning cycle.
Remove from approval flow`removeFromApprovalFlow`	DELETE	Remove an employee from all approval chains for a specific cycle.
Save budget breakdown`saveBudgetBreakdown`	PUT	Save budget breakdown for a compensation planning cycle.
Save budget guidelines`saveBudgetGuidelines`	PUT	Save budget guidelines for a compensation planning cycle.
Save change comm template`saveChangeCommTemplate`	PUT	Save the change communication email template for a compensation planning cycle.
Save recommendations`saveRecommendations`	POST	Save compensation recommendations for an employee in a cycle.
Send recommendations to next stage`sendRecommendations`	POST	Send recommendations to the next approval stage for a specific approval flow template.
Set final approver`setFinalApprover`	POST	Set or update the final approver for all approval flows in a cycle.
Update approval flow`updateApprovalFlow`	PUT	Update an approval flow for a compensation planning cycle.
Update compensation planning cycle`updatePlanningCycle`	PUT	Update compensation planning cycle details and currency settings.

Custom Reports4

Get Legacy Report Field Map`getLegacyReportFieldMap`	GET	Returns the mapping from the field identifiers the deprecated Reports Get Company Report (get-company-report) endpoint emitted to the field names the Custom Reports and Datasets endpoints...
Get Legacy Report ID Map`getLegacyReportIdMap`	GET	Returns a mapping from legacy custom report IDs to the new report IDs created by the report migration.
Get Report by ID`getCustomReport`	GET	Executes a saved custom report and returns its data using the report's configured fields and filters.
List Reports`listCustomReports`	GET	Returns a paginated list of saved custom reports available in the account.

Datasets4

Get Data from Dataset (v2)`getDatasetData`	POST	Queries the named dataset and returns the matching rows.
Get Field Options (v1.2)`getDatasetFieldOptions`	POST	Returns the allowed values for one or more fields in a dataset, for use as filter values when querying data via "Get Data from Dataset (v2)".
Get Fields from Dataset (v1.2)`getDatasetFields`	GET	Returns a paginated list of field descriptors for the specified dataset.
List Datasets (v1.2)`listDatasets`	GET	Returns the catalog of datasets available for querying via the Datasets API.

Employee Files6

Create Employee File Category`createEmployeeFileCategory`	POST	Creates one or more employee file categories (not company file categories).
Delete Employee File`deleteEmployeeFile`	DELETE	Permanently deletes an employee file.
Get Employee File`getEmployeeFile`	GET	Downloads the binary content of an employee file as an attachment.
List Employee Files`listEmployeeFiles`	GET	Lists the file categories and files visible to the caller for the specified employee.
Update Employee File`updateEmployeeFile`	POST	Updates metadata for an existing employee file.
Upload Employee File`uploadEmployeeFile`	POST	Uploads a file to an employee's file section.

Employee Tables4

Create Table Row (v1.1)`createTableRow`	POST	Add a new row to the specified employee table using the v1.1 table-row creation endpoint.
Delete Employee Table Row`deleteTableRow`	DELETE	Deletes a specific row from an employee's tabular data.
Get Employee Table Data`getEmployeeTable`	GET	Returns all rows for a given employee and table combination.
Update Table Row (v1.1)`updateTableRow`	POST	Update an existing row in the specified employee table using the v1.1 table-row update endpoint.

Employee Verification5

Enable or disable the employee verification integration`setVerificationIntegration`	PUT	Enables or disables the company's employee verification integration.
Get employee verification integration status`getVerificationIntegration`	GET	Returns the install state and partner metadata for the company's employee verification integration.
List employee verification records for an employee`listEmployeeVerifications`	GET	Returns every employee verification row for the given employee (including archived), newest first.
Send employee verification lifecycle email by user and email type`sendVerificationLifecycleEmail`	POST	Accepts a Bamboo userId (path) and an emailType (body) and queues the corresponding employee verification lifecycle email-the same templates as the in-app auth listener (signup survey...
Update an employee verification record`updateEmployeeVerification`	PUT	Partial update of a single employee verification row.

Employees7

Create Employee`createEmployee`	POST	Create a new employee.
Delete employee`deleteEmployee`	DELETE	Permanently deletes an employee record and all associated data.
Get Company Information`getCompanyInformation`	GET	Returns basic profile information for the company, including its legal name, display name, primary address, and contact phone number.
Get Employee`getEmployee`	GET	Returns a single employee record as a JSON object (or XML when Accept: application/xml).
Get Employees Directory`getEmployeeDirectory`	GET	Returns the company's published employee directory: a fieldset definition plus an array of employee records whose keys match the field ids.
List Employees`listEmployees`	GET	Lists all employees in the authenticated caller's company as a cursor-paginated list.
Update Employee`updateEmployee`	POST	Update an employee's fields by submitting a JSON object or XML document containing field name/value pairs.

Goals19

Close Goal`closeGoal`	POST	Closes a goal, moving it to the closed status.
Create Goal`createGoal`	POST	Create a new goal for an employee.
Create Goal Comment`createGoalComment`	POST	Creates a new comment on a goal.
Delete Goal`deleteGoal`	DELETE	Permanently deletes a goal for an employee.
Delete Goal Comment`deleteGoalComment`	DELETE	Deletes a goal comment.
Get Alignable Goal Options`listGoalAlignmentOptions`	GET	Returns goals that can be used as alignment targets.
Get Goal Aggregate`getGoalAggregate`	GET	Returns a single goal with its comments, alignment options, and a list of all persons who are either shared on the goal or have commented on it.
Get Goal Creation Permission`getGoalCreatePermission`	GET	Determine if the authenticated caller has permission to create a goal for this employee.
Get Goal Filters (v1.2)`getGoalFilters`	GET	Get the number of goals per status for an employee, including goals with milestones.
Get Goals Aggregate (v1.2)`getGoalsAggregate`	GET	Provides a goals dashboard for an employee: goals matching the selected filter, status filter counts/actions, comment counts, and people shared with or commenting on those goals.
List Goal Comments`listGoalComments`	GET	Returns comments for a goal, including each comment's ID, author, text, creation time, and edit/delete permissions.
List Goal Sharing Options`listGoalShareOptions`	GET	Provides a list of employees with whom the specified employee\'s goals may be shared.
List Goals`listGoals`	GET	Returns goals for an employee.
Reopen Goal`reopenGoal`	POST	Reopens a closed goal, returning it to the in-progress status.
Update Goal (v1.1)`updateGoal`	PUT	Update a goal's top-level fields and optionally add or delete milestones.
Update Goal Comment`updateGoalComment`	PUT	Updates the text of an existing goal comment.
Update Goal Progress`updateGoalProgress`	PUT	Update the progress percentage of a simple, non-milestone goal.
Update Goal Sharing`updateGoalSharing`	PUT	Replaces the full list of employees this goal is shared with.
Update Milestone Progress`updateMilestoneProgress`	PUT	Update the progress of a milestone in a goal.

Holidays8

Bulk Create Company Holidays`bulkInsertCompanyHolidays`	POST	Creates multiple company holidays in one synchronous call.
Create Company Holiday`createCompanyHoliday`	POST	Creates a company holiday.
Delete Company Holiday`deleteCompanyHoliday`	DELETE	Soft-deletes a company holiday and removes its audience, pay, and country sub-rows.
Get Catalog Holiday`getCatalogHoliday`	GET	Gets a global holiday catalog entry by UUID.
Get Company Holiday`getCompanyHoliday`	GET	Gets a company holiday by ID.
List Catalog Holidays`listCatalogHolidays`	GET	Lists entries in the global holiday catalog.
List Company Holidays`listCompanyHolidays`	GET	Returns a paginated list of active company holidays.
Update Company Holiday`updateCompanyHoliday`	PATCH	Updates a company holiday with a JSON Merge Patch (RFC 7396) document.

Hours1

Get Time Tracking RecordgetHourRecord GET Retrieves a single time tracking hour record by its ID.

Locations5

Create a job location`createJobLocation`	POST	Creates a new job location.
Delete a job location`deleteJobLocation`	DELETE	Deletes a job location by its ID.
Get a job location`getJobLocation`	GET	Retrieves a single job location by its ID.
List job locations`listJobLocations`	GET	Retrieves a paginated list of job locations.
Update a job location`updateJobLocation`	PUT	Updates an existing job location.

Meal & Rest Breaks20

Assign Employees to Break Policy`assignBreakPolicyEmployees`	POST	Assigns employees to a break policy.
Create Break`createBreak`	POST	Creates a new break and associates it with the specified break policy.
Create Break Policy`createBreakPolicy`	POST	Create a break policy.
Delete Break`deleteBreak`	DELETE	Deletes a time tracking break by its UUID.
Delete Break Policy`deleteBreakPolicy`	DELETE	Deletes a break policy by its UUID.
Get Break`getBreak`	GET	Retrieves a single time tracking break by its UUID.
Get Break Policy`getBreakPolicy`	GET	Retrieves a single break policy by its UUID.
Get Break Policy Suggestions`getBreakPolicySuggestions`	POST	Uses an AI agent to analyze existing break policies and company context, then returns structured meal and rest break policy recommendations ready for form pre-fill.
List Break Assessments`listBreakAssessments`	GET	Returns a paginated list of break assessments.
List Break Policies`listBreakPolicies`	GET	Returns a paginated list of all break policies.
List Break Policy Employees`listBreakPolicyEmployees`	GET	Retrieves employees assigned to a specific break policy.
List Breaks for Break Policy`listBreaksForPolicy`	GET	Returns a paginated list of breaks belonging to the specified break policy.
List Employee Break Availabilities`listEmployeeBreakAvailabilities`	GET	Retrieves break availability information for an employee.
List Employee Break Policies`listEmployeeBreakPolicies`	GET	Retrieves break policies assigned to a specific employee.
Replace Breaks for Break Policy`replaceBreaksForPolicy`	PUT	Replace all breaks for a break policy.
Set Employees for Break Policy`setBreakPolicyEmployees`	PUT	Sets the employee assignments for a break policy.
Sync Break Policy`syncBreakPolicy`	PUT	Performs a full replacement of a break policy and its related data (breaks and employee assignments).
Unassign Employees from Break Policy`unassignBreakPolicyEmployees`	POST	Unassigns the specified employees from a break policy.
Update Break`updateBreak`	PATCH	Partially updates a time tracking break identified by its UUID.
Update Break Policy`updateBreakPolicy`	PATCH	Partially updates a break policy identified by its UUID.

Onboarding12

Cancel new hire packet`cancelNewHirePacket`	POST	Cancels the new hire packet.
Create employee onboarding experience`createOnboardingExperience`	POST	Creates (starts) an onboarding experience workflow for the employee’s existing new hire packet instance.
Create new hire packet`createNewHirePacket`	POST	Creates a new hire packet instance (draft) for an employee.
Delete new hire packet`deleteNewHirePacket`	DELETE	Deletes a new hire packet instance by primary key.
Get employee onboarding experience by id`getOnboardingExperience`	GET	Returns a single onboarding experience when the onboarding experience phase-1 and workflow framework company toggles are enabled, the employee has at least one running...
Get new hire packet by id`getNewHirePacket`	GET	Returns a single new hire packet instance with a derived status.
Get welcome new hires widget`getNewHiresWidget`	GET	Returns the upcoming-new-hires data that powers the BambooHR home "Welcome New Hires" widget.
List employee onboarding experiences`listOnboardingExperiences`	GET	Returns onboarding experiences for the employee when the onboarding experience phase-1 and workflow framework company toggles are enabled, and at least one OnboardingExperienceWorkflow...
List new hire packets`listNewHirePackets`	GET	Returns a paginated list of new hire packet instances for the company.
Send new hire packet`sendNewHirePacket`	POST	Sends the new hire packet for that packet's employee (email or onboarding experience workflow, depending on company configuration).
Update GTKY answer visibility for a new hire packet`setGtkyVisibility`	PUT	Shows or hides get-to-know-you (GTKY) question answers for the packet.
Update new hire packet`updateNewHirePacket`	PUT	Updates an existing new hire packet instance.

Pay Grades & Bands14

Delete Compensation Level Groups or Level`deleteLevelGroups`	DELETE	Deletes compensation level configuration, with the behavior chosen by the {segment} path value.
Get Compensation Level Group Status Counts`getLevelGroupStatusCounts`	GET	Returns the number of compensation level groups in each lifecycle status.
Get Job Titles and Level Assignments`getJobTitleLevels`	GET	Returns the working draft configuration showing which job titles are assigned to each compensation level, as used by the pay grades and bands setup wizard.
Get Levels and Bands Review`getLevelsAndBandsReview`	GET	Returns the pre-publish review of compensation level groups and levels with validation errors and warnings consolidated across every setup-wizard step: level naming, group-level checks,...
Get Levels and Bands Status`getLevelsAndBandsStatus`	GET	Returns the configuration status of the Pay Grades & Bands (levels and bands) setup, broken down by setup step.
Get Pay Bands`getPayBands`	GET	Returns the working draft pay band configuration for every compensation level, including the pay-band-step validation errors and warnings used by the setup wizard.
Get Published Levels and Bands`getPayGradesAndBands`	GET	Returns the currently published pay grades and bands as a JSON object with a groups array.
List Compensation Level Groups and Levels`listLevelGroups`	GET	Returns the working draft configuration of compensation level groups and levels, including the per-group and per-level validation errors and warnings used by the setup wizard.
List Job Titles with Employees`listJobTitlesWithEmployees`	GET	Returns every active, non-archived company job title (not only titles used in the pay grades and bands configuration) together with the employees who currently hold each title.
Publish Draft Compensation Level Groups`publishLevelGroups`	POST	Publishes the company draft compensation configuration, promoting every draft compensation level group, along with its levels, pay bands, and job-title assignments, to the live published...
Replace Job Title Level Assignments`updateJobTitleLevels`	PUT	Replaces the complete set of draft job title-to-compensation-level assignments with the associations in the request.
Update Compensation Level Groups and Levels`saveLevelGroups`	PUT	Creates or updates compensation level groups and their levels in the company draft configuration.
Update Pay Bands`updatePayBands`	PUT	Updates the pay band values (min, mid, max, percentageRange) for compensation levels in the company's draft pay grades and bands.
Upload Levels and Bands CSV`importLevelsAndBands`	POST	Parses an uploaded levels and bands CSV and returns a preview of the parsed rows along with a suggested column mapping.

Photos2

Get Employee Photo`getEmployeePhoto`	GET	Returns an employee photo at the requested size.
Upload Employee Photo`uploadEmployeePhoto`	POST	Uploads a new photo for an employee.

Public Api5

Create Hour Record`createHourRecord`	POST	Adds a single hour record.
Create or Update Hour Records`storeHourRecords`	POST	Bulk add/edit hour records.
Delete Hour Record`deleteHourRecord`	DELETE	Deletes an hour record by timeTrackingId (id path parameter).
Update Company Industry Codes`updateIndustryCodes`	PUT	Updates the industry codes associated with a company.
Update Hour Record`adjustHourRecord`	PUT	Edits an existing hour record by timeTrackingId.

Scheduling14

Create Schedule`createSchedule`	POST	Creates a new schedule for the company.
Create Shift`createShift`	POST	Creates a new shift in the specified schedule.
Delete Schedule`deleteSchedule`	DELETE	Deletes a schedule by its UUID.
Delete Shift`deleteShift`	DELETE	Deletes a shift by its UUID or composite recurrence ID.
Get Schedule`getSchedule`	GET	Retrieves a specific schedule by its UUID.
Get Schedule PDF`getSchedulePdf`	GET	Generates and streams a PDF of the schedule view for the given schedule and date range.
Get Shift`getShift`	GET	Retrieves a single shift by its UUID.
List Schedules`listSchedules`	GET	Retrieves a paginated list of all schedules for the company.
List Shift Assessments`listShiftAssessments`	GET	Lists shift assessments matching the given filters.
List Shifts`listShifts`	GET	Lists shifts matching the given filters.
List Timezones`listSchedulingTimezones`	GET	Returns a paginated list of timezones available for use when creating or editing schedules.
Publish Shifts`publishShifts`	POST	Publishes one or more planned shifts, making them visible to employees.
Update Schedule`updateSchedule`	PATCH	Partially updates an existing schedule by its UUID.
Update Shift`updateShift`	PATCH	Updates a shift by its UUID.

Time Off11

Adjust Time Off Balance`adjustTimeOffBalance`	PUT	Creates a balance adjustment for an employee's time off type.
Assign Time Off Policies (v1.1)`assignTimeOffPolicies`	PUT	Assigns time off policies to an employee with accruals starting on the specified date.
Create Time Off History Item`createTimeOffHistoryItem`	PUT	Creates a time off history item for an employee.
Create Time Off Request`createTimeOffRequest`	PUT	Creates a time off request for an employee.
Get Time Off Balance`getTimeOffBalance`	GET	Returns time off balances for an employee across all assigned categories as of a given date.
List Employee Time Off Policies (v1.1)`listEmployeeTimeOffPolicies`	GET	Returns the time off policies currently assigned to a specific employee, as a list of {timeOffPolicyId, timeOffTypeId, accrualStartDate} records.
List Time Off Policies`listTimeOffPolicies`	GET	Returns all non-deleted time off policies for the company, sorted alphabetically by name.
List Time Off Requests`listTimeOffRequests`	GET	Returns time off requests within the specified date range.
List Time Off Types`listTimeOffTypes`	GET	Lists the company's active time off types - PTO options, vacation, sick leave, and other time off categories - along with the company's default hours-per-day schedule.
List Who’s Out`listWhosOut`	GET	Returns a date-sorted list of employees who are out and company holidays for the specified period.
Update Time Off Request Status`updateTimeOffRequestStatus`	PUT	Updates the status of an existing time off request.

Time Tracking38

Approve Timesheet`approveTimesheet`	POST	Approves a timesheet (process resource).
Clock In`createClockIn`	POST	Clocks an employee in at the current server time, creating an open clock entry (end: null).
Clock Out`createClockOut`	POST	Clocks an employee out at the current server time, closing the employee's open clock entry (end set, endSource: USER).
Create Clock Entry`createClockEntry`	POST	Manually creates a time tracking clock entry (corrections, retroactive entry).
Create Hour Entry`createHourEntry`	POST	Creates a new time tracking hour entry.
Create or Update Timesheet Clock Entries`storeClockEntries`	POST	Creates or updates timesheet clock entries in bulk.
Create or Update Timesheet Hour Entries`storeHourEntries`	POST	Creates or updates timesheet hour entries in bulk.
Create Time Tracking Project`createTimeTrackingProject`	POST	Creates a time tracking project.
Create Time Tracking Project Task`createProjectTask`	POST	Creates a new task on the specified time tracking project.
Create Time Tracking Shift Differential`createShiftDifferential`	POST	Creates a new time tracking shift differential.
Create Timesheet Clock-In Entry`clockIn`	POST	Clocks in an employee at the current server time.
Create Timesheet Clock-Out Entry`clockOut`	POST	Clocks out a currently clocked-in employee at the current server time.
Delete Clock Entry`deleteClockEntry`	DELETE	Deletes a time tracking clock entry by its ID.
Delete Hour Entry`deleteHourEntry`	DELETE	Deletes a time tracking hour entry by its ID.
Delete Time Tracking Project`deleteTimeTrackingProject`	DELETE	Deletes a time tracking project by its ID.
Delete Time Tracking Shift Differential`deleteShiftDifferential`	DELETE	Deletes a time tracking shift differential by its ID.
Delete Time Tracking Task`deleteTimeTrackingTask`	DELETE	Deletes a time tracking task by its ID.
Delete Timesheet Clock Entries`deleteClockEntries`	POST	Deletes one or more timesheet clock entries by their IDs.
Delete Timesheet Hour Entries`deleteHourEntries`	POST	Deletes one or more timesheet hour entries by their IDs.
Get Clock Entry`getClockEntry`	GET	Retrieves a single clock entry by its ID.
Get Hour Entry`getHourEntry`	GET	Retrieves a single hour entry by its ID.
Get Time Tracking Project`getTimeTrackingProject`	GET	Retrieves a single time tracking project by its ID, including the list of employees assigned to it.
Get Time Tracking Shift Differential`getShiftDifferential`	GET	Retrieves a single time tracking shift differential by its ID.
Get Time Tracking Task`getTimeTrackingTask`	GET	Retrieves a single time tracking task by its ID.
Get Timesheet`getTimesheet`	GET	Retrieves a single timesheet by its ID.
Get Timesheet Summary`getTimesheetSummary`	GET	Returns the daily breakdown of hours for a timesheet, including regular, overtime, and double-time hours per day.
List Clock Entries`listClockEntries`	GET	Returns a paginated list of time tracking clock entries.
List Hour Entries`listHourEntries`	GET	Returns a paginated list of time tracking hour entries.
List Time Tracking Project Tasks`listProjectTasks`	GET	Returns a paginated list of tasks for the specified time tracking project.
List Time Tracking Projects`listTimeTrackingProjects`	GET	Returns a paginated list of time tracking projects.
List Time Tracking Shift Differentials`listShiftDifferentials`	GET	Returns a paginated list of time tracking shift differentials.
List Timesheet Entries`listTimesheetEntries`	GET	Returns timesheet entries for all employees, or a filtered subset, within the specified date range.
List Timesheets`listTimesheets`	GET	Returns a paginated list of timesheets.
Update Clock Entry`updateClockEntry`	PATCH	Partially updates a time tracking clock entry identified by its ID.
Update Hour Entry`updateHourEntry`	PATCH	Partially updates a time tracking hour entry identified by its ID.
Update Time Tracking Project`updateTimeTrackingProject`	PATCH	Partially updates a time tracking project identified by its ID.
Update Time Tracking Shift Differential`updateShiftDifferential`	PATCH	Partially updates a time tracking shift differential identified by its ID.
Update Time Tracking Task`updateTimeTrackingTask`	PATCH	Partially updates a time tracking task identified by its ID.

Total Rewards8

Add Employees to Total Rewards`addTotalRewardsEmployees`	POST	Add employees to Total Rewards.
Check Total Rewards Profile Availability`checkTotalRewardsProfile`	GET	Check if the given employee has an active Total Rewards profile and the current user has permission to view it.
Get Printable Total Rewards Statement`getPrintableTotalRewards`	GET	Generate and return a PDF printable version of the employee's Total Rewards statement.
Get Total Rewards Statement`getTotalRewardsStatement`	GET	Returns the full Total Rewards statement for the given employee, including compensation, benefits, bonuses, equity, reimbursements, and time-off data.
Remove Employees from Total Rewards`removeTotalRewardsEmployees`	DELETE	Remove employees from Total Rewards.
Remove Total Rewards Custom Disclaimer`removeTotalRewardsDisclaimer`	DELETE	Remove the company-wide Total Rewards custom disclaimer.
Set Total Rewards Custom Disclaimer`setTotalRewardsDisclaimer`	PUT	Set the company-wide Total Rewards custom disclaimer text shown on employee statements.
Set Total Rewards Onboarding Step Status`setTotalRewardsOnboardingStep`	PUT	Set a Total Rewards onboarding step to completed or incomplete.

Training12

Create Employee Training Record`createTrainingRecord`	POST	Creates a new training record for the specified employee.
Create Training Category`createTrainingCategory`	POST	Creates a new training category.
Create Training Type`createTrainingType`	POST	Creates a new training type.
Delete Employee Training Record`deleteTrainingRecord`	DELETE	Delete an existing employee training record.
Delete Training Category`deleteTrainingCategory`	DELETE	Delete an existing training category.
Delete Training Type`deleteTrainingType`	DELETE	Delete an existing training type.
List Employee Training Records`listTrainingRecords`	GET	Returns all training records for the specified employee as an object keyed by training record ID.
List Training Categories`listTrainingCategories`	GET	Returns all training categories for the company as an object keyed by category ID.
List Training Types`listTrainingTypes`	GET	Returns all training types for the company as an object keyed by training type ID.
Update Employee Training Record`updateTrainingRecord`	PUT	Updates an existing employee training record.
Update Training Category`updateTrainingCategory`	PUT	Updates the name of an existing training category.
Update Training Type`updateTrainingType`	PUT	Updates an existing training type.

Webhooks8

Create Webhook`createWebhook`	POST	Creates a new webhook for the authenticated user.
Delete Webhook`deleteWebhook`	DELETE	Permanently removes a webhook owned by the authenticated user.
Get Webhook`getWebhook`	GET	Returns the full configuration of a single webhook owned by the authenticated user, including its name, URL, format, monitored fields and post fields when applicable, events, creation...
Get Webhook Post Fields`listPostFields`	GET	Returns an object containing the employee fields that can be included in the webhook post body for field-based webhooks.
List Monitor Fields`listMonitorFields`	GET	Returns the list of employee fields that can be monitored by a webhook.
List Webhook Logs`listWebhookLogs`	GET	Returns an array of recent delivery log entries for a webhook.
List Webhooks`listWebhooks`	GET	Returns all webhooks owned by the authenticated user.
Update Webhook`updateWebhook`	PUT	Performs a full replacement update of a webhook - all request body fields overwrite existing values, so omitted optional fields revert to defaults.