Export Compensation Benchmark Details
Returns a CSV export of the compensation benchmark detail view for a single job, optionally scoped to a specific location. Rows include employee-level data (name, location, annualized pay, compa-ratio, range penetration, years of experience) alongside the company's internal pay band for the job. Use GET /api/v1/compensation/benchmarks to find valid jobId and locationId values. When locationId is omitted, the export aggregates across all locations for the job.
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.
Query parameters
ID of the company job title to export benchmark details for.
Optional job location ID to restrict the export to one location.
Response
CSV payload streamed with a Content-Disposition: attachment header. The filename is derived from the job title and location.
Changes
No recorded changes to this operation across all 2 revisions of this API.