Skip to Content
Changelog & versioning

Changelog

Change history of the Kinmu Public API. Incompatible changes are never applied within a major version: they are introduced in a new version and announced here.

Versioning policy

  • The version goes in the URL: https://api.kinmu.app/v1.
  • Frozen contract within v1. We do not introduce incompatible changes in v1.

What we consider a compatible change (non-breaking)

These changes can happen in v1 without prior notice; your integration must tolerate them:

  • Adding new endpoints or resources.
  • Adding new fields to a response.
  • Adding new values to an enum documented as extensible (e.g. custom absence types).
  • Adding optional query or body parameters.
  • Changing the text of error messages (title, detail) — that’s why your logic must be based on the stable code field.

Design tolerant clients. Ignore fields you don’t recognize and don’t assume a fixed order in lists. That way compatible changes won’t affect you.

What we consider an incompatible change (breaking)

Requires a new major version (v2):

  • Removing or renaming an endpoint, field or enum value.
  • Changing the type of a field or making it required.
  • Changing the meaning of a field or the code of an error.

Deprecation policy (12 months)

When we deprecate an endpoint, field or version:

  1. It is announced in this changelog and in the developer mailing list.
  2. It is marked as deprecated in the OpenAPI spec and, where applicable, with the Deprecation + Sunset response headers.
  3. It remains operational for at least 12 months from the announcement before being retired.

Subscribe to notices on the support page.

History

v1 · 1.0.0

OpenAPI spec published (openapi-v1.json, v1.0.0). The interactive reference reads the real spec. The v1 surface is a frozen contract; changes are announced here under the 12-month deprecation policy.

Launch resources (MVP):

  • Organization — GET /v1/organization (introspection).
  • Employees — list, get, create, update and terminate.
  • Check-ins — list, get and record check-ins.
  • Work summaries — workday aggregates for payroll.
  • Absences — list, get, create, approve and reject.
  • Vacation balances — vacation balances.
  • Locations / Units — organizational structure (read-only).
  • Reports — asynchronous reports (legal time registry and exports), with file download via GET /v1/reports/{id}/download.

Webhooks:

  • Signed outgoing events (Standard Webhooks): endpoint management, ping sending, delivery listing and manual re-queue of a delivery via POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry.
Last updated on
API ReferenceSupport