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.
| Method | Endpoint | Limit |
|---|
| GET | Get sync report data | 5 requests per minute |
| PUT | Update sync request records | 100 requests per minute |
| GET | Get integrations metadata | 5 requests per minute |
To use the Payroll Hub Partners API, your OAuth app requires the following scopes:
| Name | Scope | Description |
|---|
| Payroll Hub > Sync employee data to Payroll Hub | payrollhub.employee_sync:write | Sync payroll-related employee data through dedicated reports. |
| Settings > View company metadata | company.metadata:read | Read employee fields, lists, goals and payroll integration metadata. |
