v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBGet Company Report
Deprecated. Use Custom Reports > Get Report by ID instead.
Returns the data from an existing saved custom report. Non-admins can find these reports in My Reports. Admins can find them in Custom Reports under the My Reports and Company Reports tabs. The report ID can be found by hovering over the report name in BambooHR and noting the ID in the URL. Standard Reports are not available via this endpoint, and report IDs are company-specific.
The caller must have permission to view or access the report. The format query parameter is case-insensitive (json, JSON, Json are all accepted). If format is omitted, the output format is inferred from the Accept header, but only these exact values are supported: application/json, text/xml, text/csv, application/pdf, application/vnd.ms-excel. Any other Accept value (including application/xml and */*) returns 404.
OAuth Scopes: report
Path parameters
The integer ID of the saved custom report to run. Find this ID by hovering over the report name in the BambooHR Reports tab and noting the ID in the URL.
Query parameters
The output format for the report. Case-insensitive. If omitted, format is inferred from the Accept header — only application/json, text/xml, text/csv, application/pdf, and application/vnd.ms-excel are accepted; any other value returns 404.
Controls duplicate row filtering. yes applies standard deduplication (default for JSON and XML formats). no returns raw results without filtering (default for CSV and XLS formats).
Whether to restrict historical fields to current values only. Set to false to include future-dated history values in the report output. Defaults to true.
Headers
The desired response content type when format is omitted. Accepted values: application/json, text/xml, text/csv, application/pdf, application/vnd.ms-excel. Any other value returns 404.
Response
Report data in the requested format. For JSON, returns an object with a title string, a fields array (each element has id, type, and name), and an employees array (each element has id plus one key per report field). For XML (text/xml), returns a <report> document. For CSV/XLS/PDF, returns file content with the appropriate content-type header.