Account Information13

Alerts5

Applicant Tracking10

Benefits10

Calendar Events1

Change Tracking2

Company Files6

Company Profile3

Compensation3

Compensation Benchmarking11

Compensation Planning28

Custom Fields12

Custom Reports4

Custom Tables7

Datasets8

Employee Files6

Employee Tables6

Employee Verification5

Employees8

Field Metadata4

Goals24

Holidays8

Hours1

Locations5

Login1

Meal & Rest Breaks20

Onboarding12

Pay Grades & Bands14

Photos2

Public API5

Recognition Settings1

Reports2

Scheduling21

Time Off37

Time Tracking63

Total Rewards8

Training12

Webhooks8

Webhooks

Webhook Events6

Total Rewards

Public API

Remove Employees from Total Rewards

Remove employees from Total Rewards. Their Total Rewards profiles will be deleted.

OAuth Scopes: total_rewards.write

delete/api/v1/compensation/total_rewards/employees

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
OAuth 2
Authorization code/authorize.php
Token URL/token.php
Scopestotal_rewards.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/total_rewards/employees/delete.ts
A function with typed inputs. Its response is checked against the schema.

Request body

employeeIdsinteger[] required

List of internal employee IDs to remove from Total Rewards.

Response

Employees successfully removed from Total Rewards.

Changes

No recorded changes to this operation across all 2 revisions of this API.

Remove Employees from Total Rewards

Request

Request body

Response 200OK

Changes

Response