Compensation Planning
Public API
Get compensation planning cycle worksheet
Changed onGet compensation planning worksheet details for the cycle (recommendations, approvals, or overview context). Omit type to use the default view for the current user.
OAuth Scopes: planning_cycles
get/api/v1/compensation/planning_cycles/{id}/worksheet
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesplanning_cycles
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idinteger required
Query parameters
type'recommendations' | 'approvals' | 'overview'
Worksheet context: recommendations, approvals, or overview (overview requires cycle admin).
Response
Success
object required
Changes
- info
api operation id
329acecaa6df729733d0752aa9f6b204removed and replaced withfdffbb9803f77a9bd0c13a3f206a41d4
- info