The Reports API provides access to the details of your company reports.
Required permissions
The service user that you use for the Reports endpoints should have the following permissions based on the report type and the scope of data it includes:
| Report type/scope | permission |
|---|---|
| All reports | Features > Reports > View reports according to people's data access rights |
| Reports with formulas | Features > Formulas in Grids > View formulas in grids |
| Time & Attendance reports | People's Data > Time attendance > Manage time attendance |
| Time off reports | People's Data > Time off > Requests > View, approve or decline requests that are pending approval of others |
To learn more about permissions, see Setting permissions to Service Users.
Rate limiting
Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.
Below is a table detailing the rate limits for each endpoint in the Onboarding endpoints.
| Method | Endpoint | Limit per minute |
|---|---|---|
| GET | Read company reports | 20 |
| GET | Download the report by ID | 20 |
| GET | Get the report download URL for polling | 20 |
| GET | Download report by file URL | 20 |