Public API

An API that turns your sales into pay

Your billing, booking or point-of-sale system already knows who sold what. Send those events to Clockroll and commission is calculated without anyone exporting a spreadsheet.

What can the API do?

  • Send events — sales and metrics, with optional splits between workers.
  • Sync workers and billable items from your system, by your own ids.
  • Send attendance check-ins and check-outs.
  • Read earnings for a worker for the current or a past month.
  • Read advance ledgers and payroll runs.

What does an event look like?

POST /v1/tenants/{tenant_id}/events
{
  "event_id": "8f1c…",          // your id — safe to retry
  "kind": "sale",
  "worker_id": "a21e…",
  "category": "service",
  "amount_paise": 120000,       // integer minor units
  "occurred_at": "2026-09-01T08:30:00Z",
  "participants": [
    { "worker_id": "a21e…", "share_pct": 60 },
    { "worker_id": "c94b…", "share_pct": 40 }
  ]
}

Every event is idempotent on its id, so a retry after a timeout never double-counts. Amounts are integers in the smallest currency unit and times are UTC.

How are API keys handled?

Admins create keys per business in Settings → API, each with the scopes it needs. A key is shown once and stored only as a hash; revoke it any time. A key can only act on its own business.

Does Clockroll store my customers' or staff names?

Not through the API. Workers and items are identified by your own opaque ids; your system keeps the names. All the pay maths — tiers, thresholds, payroll — stays inside Clockroll, so your software never has to recalculate it.

Related features

Ready to run payday without the spreadsheet?

Free for up to 5 workers, with every feature. No card needed.