v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBList Reports
Returns a paginated list of saved custom reports available in the account. Each report entry contains an id (integer) and a name (string). Pass a report's id to "Get Report by ID" to execute it and retrieve its data.
Results default to page 1 with 500 records per page (maximum 1000). Out-of-range page numbers are clamped to the nearest valid page rather than returning an error. Invalid or zero values for page and page_size fall back to their defaults.
The pagination object includes total_records, current_page, total_pages, and nullable next_page/prev_page links. When there is no next or previous page the corresponding value is null.
OAuth Scopes: report
Query parameters
The page number to retrieve. Out-of-range values are clamped to the nearest valid page. Defaults to 1.
The number of records to retrieve per page. Defaults to 500. Maximum is 1000.
Response
Returns an object containing a reports array of report objects and a pagination object with page navigation metadata.
Example response
{
"reports": [
{
"id": 4,
"name": "New"
}
],
"pagination": {
"next_page": "https://{companyDomain}.bamboohr.com/api/v1/{endpointPath}?page=3&page_size=1",
"prev_page": "https://{companyDomain}.bamboohr.com/api/v1/{endpointPath}?page=1&page_size=1"
}
}