Guides
Guides
The conventions every Kelomo endpoint shares. Read Authentication first; the rest apply as you need them. Endpoint-level detail lives in the API reference.
Authentication
API keys, capability scopes, read-only keys, expiry, rotation and rate limits.
OAuth 2.1
Let customers connect your app by signing in — discovery, PKCE, rotating refresh tokens and consent.
Pagination
Cursor pagination on every list, plus updatedSince for a resumable incremental sync.
Errors
RFC 9457 problem+json responses with a machine-readable code field.
Error code reference
Every machine-readable code the API can return, and what to do about the common ones.
Webhooks
Subscriptions, HMAC signatures, retries, dedupe and the integration-event log.
Event catalogue
Every event Kelomo delivers, the capability to subscribe to it and its payload shape.
Idempotency
The Idempotency-Key header — required on money-document operations.
Time data
Import a workforce’s hours, the draft-vs-confirmed boundary, range caps and safe retries.
Provisioning people
Create, invite, roster, terminate and offboard employees from your HR system.
Deprecation policy
12 months before a removal, 6 before a behaviour change — and the Deprecation and Sunset headers that announce it.
Limits and quotas
Rate limits, page sizes, date windows and payload bounds — and the headers that report them.
MCP server
Connect Claude Code, Cursor or the Claude API to Kelomo over MCP.