Get Company Report

get deprecated

https://{companyDomain}.bamboohr.com/api/v1/reports/{id}

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Sample Response

{
    "title": "This is my report",
    "fields": [
        {
            "id": "firstName",
            "type": "text",
            "name": "First Name"
        },
        {
            "id": "lastName",
            "type": "text",
            "name": "Last Name"
        },
        {
            "id": "91",
            "type": "employee",
            "name": "Supervisor"
        },
    ],
    "employees": [
        {
            "firstName":"John",
            "lastName":"Doe",
            "91": "Jane Doe"
        }
    ]
}

Parameters

Format - the output format for the report. Supported formats: CSV, PDF, XLS, XML, JSON
fd (optional) - yes=apply standard duplicate field filtering, no=return the raw results with no duplicate filtering. Default value is "yes".

Response Notes

Column names - Note that the field names in the employee records don't have to match the display names for the columns. The field name used is defined by the relevant data in the 'fields' section of the response.

Path Params

integer

required

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 Params

format

string

enum

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.

Allowed:

string

enum

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).

Allowed:

onlyCurrent

boolean

Defaults to true

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

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Access denied. The authenticated user does not have permission to view this report.

404

Not found. Returned when the report ID does not exist or belongs to a different company, when an unsupported format value is supplied (e.g. ?format=bogus), or when format is omitted and the Accept header is not one of the supported exact values (application/json, text/xml, text/csv, application/pdf, application/vnd.ms-excel).