Get Levels and Bands Review
Changed onReturns the pre-publish review of compensation level groups and levels with validation errors and warnings consolidated across every setup-wizard step: level naming, group-level checks, and pay band values. This reflects the working draft configuration; when no draft exists it falls back to the currently published configuration. Requesting this review marks all setup steps as visited for the draft, which changes subsequent Get Levels and Bands Status (get-levels-and-bands-status) results. The response is a JSON object with a groups array; each group carries its levels plus its own errors and warnings, and each level flattens its pay band into min, mid, max, and percentageRange value objects (each wrapping a numeric value with its own errors and warnings), along with currencyCode, compensationType, and the jobTitles assigned to that level. Use this for the complete validation picture that determines whether the configuration can be published. For the editable draft view that validates level and group issues but not pay band values, use List Compensation Level Groups and Levels (list-compensation-level-groups-and-levels) instead. For the currently published pay grades and bands without any validation state, use Get Published Levels and Bands (get-published-levels-and-bands) instead.
OAuth Scopes: pay_grades_and_bands
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopespay_grades_and_bands
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Compensation level groups and levels with consolidated validation state, as an object with a groups array.
Changes
- breaking
the response property
became optional for the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
////from the response with the status - info
api operation id
12c40475623893cf0434b3ae69e36975removed and replaced withget-levels-and-bands-review - info
api tag
Pay Grades & Bandsadded - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
////to the response with the status - info
added the optional property
//to the response with the status
- breaking