Total Rewards
Public API
Check Total Rewards Profile Availability
Check if the given employee has an active Total Rewards profile and the current user has permission to view it. Returns 204 when the employee has a profile and the user is authorized; 404 if the profile does not exist or the user lacks access.
OAuth Scopes: total_rewards
get/api/v1/compensation/total_rewards/{employeeId}
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopestotal_rewards
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
employeeIdstring required
The internal employee ID of the employee to check.
Response
Employee has an active Total Rewards profile and the user can view it.
Changes
No recorded changes to this operation across all 2 revisions of this API.