Get Report by ID

Executes a saved custom report and returns its data using the report's configured fields and filters. The data array contains employee record objects whose keys are determined by the fields selected when the report was created — each object is a flat key-value map where keys are field names (e.g. firstName, status, hireDate) and values are strings or null. The aggregations array is empty unless the report's underlying dataset configuration includes aggregation rules. Use "List Reports" to discover available report IDs.

Results default to page 1 with 500 records per page (maximum 1000). Out-of-range page numbers are clamped to the nearest valid page. Invalid or zero values for page and page_size fall back to their defaults.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The numeric ID of the saved custom report to execute.

Query Params
integer
≥ 1
Defaults to 1

The page number to retrieve. Defaults to 1.

integer
1 to 1000
Defaults to 500

The number of records per page. Defaults to 500. Maximum is 1000.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json