---
title: "Check Total Rewards Profile Availability"
method: GET
path: "/api/v1/compensation/total_rewards/{employeeId}"
tags: ["Total Rewards", "Public API"]
---

# Check Total Rewards Profile Availability

`GET /api/v1/compensation/total_rewards/{employeeId}`

## Request

- Base URL: `https://companySubDomain.bamboohr.com`
- URL: `https://companySubDomain.bamboohr.com/api/v1/compensation/total_rewards/{employeeId}`
- Auth: OAuth 2
  - Authorization code: `/authorize.php`
  - Token URL: `/token.php` scopes: `total_rewards`
- TypeScript: <https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/compensation/total_rewards/:employeeId/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `employeeId` string, required

## Response `204`

Employee has an active Total Rewards profile and the user can view it.

## Other responses

- `404`: Employee does not have a Total Rewards profile or the user lacks permission.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/bamboohr/apis/bamboohr-api.md) - [All operations](https://skmtc.dev/bamboohr/apis/bamboohr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboohr/apis/bamboohr-api/revisions/922fc15f43a7?raw)