Kinmu Public API
Integrate Kinmu time tracking with your payroll software, your access control system or your BI tools. A versioned REST API with company credentials, explicit scopes and signed webhooks.
curl https://api.kinmu.app/v1/organization \
-H "Authorization: Bearer $KINMU_API_KEY"Start here
Enable the addon, create a key and make your first call in about 5 minutes.
QuickstartScopes, rotation, sandbox and best practices.
Authentication & API keysPagination, errors, idempotency and limits.
ConventionsExplore the 9 resources and try each endpoint.
Interactive referenceIntegrate your use case
Effective hours, absences and vacation balances for your payroll cycle.
Payroll & labor advisoryRecord check-ins from turnstiles, cards or kiosks with POST /v1/check-ins.
Incremental sync via polling for your dashboards.
BI / Power BIWhat v1 exposes
The v1 surface is 9 REST resources under https://api.kinmu.app/v1:
| Resource | Purpose |
|---|---|
| Organization | Introspection of the credential and the company. |
| Employees | Adding, terminating and updating employees. |
| Check-ins | Check-in events (in/out/break) with origin. |
| Work summaries | Workday aggregates for payroll. |
| Absences | Absences: creation, approval and rejection. |
| Vacation balances | Vacation balances per employee and year. |
| Locations / Units | Organizational structure (read-only). |
| Reports | Asynchronous reports (legal time registry, exports). |
| Webhooks | Signed outgoing events (Standard Webhooks). |
The company is always resolved from the credential. There is never a {companyId} in the public routes or in the body.
Principles
- Frozen contract. Whatever enters v1 does not change in an incompatible way; every deprecation is announced 12 months in advance in the changelog.
- Least privilege. Every key carries explicit scopes; without a scope there is no access (
403 invalid_scope). - Fully audited. Every request with a company key is logged with
origin=public_api. - Same rules as the app. Writes via the API go through the same domain validations as the application.