4 articles

External API

One key per company with scopes, Bearer authentication, 100 requests per minute and what to do while there are no webhooks.

Generating an API key

Under API keys, create the key and tick the scopes (employees, payroll, departments, positions, timeclock, reports, in read or write). It is shown only once.

Authenticating requests

Send the Authorization: Bearer <key> header on every call. An invalid key answers 401; a valid key without the endpoint's scope answers 403.

Webhooks and how to track events today

Outbound webhooks are not available yet. To react to events, poll the read endpoints at a regular interval, within the 100 requests per minute limit.

Rate limits and scopes

100 requests per minute per key, with X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset on every response; beyond that, 429 with Retry-After.

Didn't find what you needed?

Contact support