DocumentationAPI Reference
API Reference

Get Total Rewards Statement

get
https://{companyDomain}.bamboohr.com/api/v1/compensation/total_rewards//statement

Returns the full Total Rewards statement for the given employee, including compensation, benefits, bonuses, equity, reimbursements, and time-off data.

OAuth Scopes: total_rewards

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The internal employee ID of the employee whose total rewards statement is returned.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 3 months ago