Getting started

Before you start, explore Reports API to learn how to generate and download reports using the Reports API.

Required permissions

The service user that you use for the Reports endpoints should have the following permissions:

Permissions to access reports.
Permissions to access the data the report is generating, based on the report type, the employees it wants to includes in the report and the scope of data it includes.

Permissions to access reports include:

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
Example for specific report:
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