Developers

API-first by design

Authenticate with OAuth2 client credentials, then call the same services that power the dashboard.

1. Get a token

POST /api/v1/oauth/token
{ "grant_type":"client_credentials",
  "client_id":"...", "client_secret":"..." }

2. Create an employee

POST /api/v1/employees
{ "first_name":"Ada",
  "last_name":"Obi",
  "external_reference":"EMP-9288" }

3. Run payroll

POST /api/v1/payroll-runs
POST /api/v1/payroll-runs/{id}/calculate
POST /api/v1/payroll-runs/{id}/submit

4. Disburse & reconcile

POST /api/v1/payroll-runs/{id}/disburse
GET  /api/v1/payouts/{reference}
GET  /api/v1/payroll-runs/{id}/reconciliation

Highlights

  • Sandbox & live environments
  • Granular OAuth scopes
  • Per-tenant isolation
  • Idempotency keys
  • Signed webhooks (HMAC-SHA256)
  • Rate limiting & IP allowlists
  • Pagination, filtering, sorting
  • OpenAPI specification