List Compensation Benchmarks
Changed onReturns every job/location pair the company tracks for compensation benchmarking. Each entry includes job and location identifiers, the benchmarks attached to that pair, the employees currently assigned to that job and location, and the company's configured internal pay band if one exists. Use the returned jobDetails.id and locationDetails.id values as the jobId and locationId inputs for GET /api/v1/compensation/benchmarks/details. Top-level dismiss*Banner fields reflect UI banner state and are not part of the benchmark data contract.
OAuth Scopes: compensation_benchmarks
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopescompensation_benchmarks
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Object with a jobLocationPairs array and banner-dismissal flags.
Changes
- 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