Sync Requests

Before you begin

Payroll hub API endpoints

ResourceEndpoint
sync report records[BETA] Get sync report data
Sync status[BETA] Update sync request records
integrations metadata[BETA] Get integrations metadata

Payroll hub API webhooks

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.

MethodEndpointLimit
GETGet sync report data5 requests per minute
PUTUpdate sync request records100 requests per minute
GETGet integrations metadata5 requests per minute

Required permissions and scopes

To use the Payroll Hub Partners API, your OAuth app requires the following scopes:

NameScopeDescription
Payroll Hub Sync Status - Writepayrollhub.employee_sync:writeAllows the partner to fetch and sync employee data.
Settings > View company metadatacompany.metadata:readView company fields and related metadata (required for Get integrations metadata).