Kimai API

Name: Kimai API
Brand: Kimai API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityTask Managementbearer, apiKey45 EndpointsREST

For Agents

Start, stop, and edit Kimai timesheets, manage the projects and customers they roll up to, and read recent or running entries from a self-hosted Kimai instance.

Install Jentic One Beta

Connect the Kimai API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Kimai API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Kimai API.

Start and stop running timesheets for the authenticated user

Create timesheet entries with project, activity, and tag attribution

Duplicate and export existing timesheet entries

Maintain the project and customer hierarchy that timesheets roll up to

GET STARTED

Start building with Kimai API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Kimai API, keeping it validated and agent-ready. Kimai is an open-source time-tracking application and its REST API exposes the full timesheet, project, customer, activity, user, team, and tag model. Operations cover starting and stopping running timesheets, duplicating or exporting entries, and the standard CRUD surface for projects and customers. Self-hosted Kimai installations expose this API at a host-specific base URL with either bearer or X-AUTH-TOKEN header authentication.

Use Cases

Patterns agents use Kimai API for, with concrete tasks.

★ Stop the running timer at end of day

An automation can list active timesheets with GET /api/timesheets/active and stop them with PATCH /api/timesheets/{id}/stop on a schedule, ensuring no entry is left running overnight. The combined call typically completes in well under a second per user.

Call GET /api/timesheets/active, then PATCH /api/timesheets/{id}/stop for every entry returned.

Daily timesheet creation from a calendar

A morning workflow can read the day's calendar events and POST /api/timesheets for each meeting, attaching the right project and activity. Kimai records the entries against the customer hierarchy so they can be invoiced or reported on without manual entry.

For each calendar event today, POST a timesheet to /api/timesheets with begin, end, project, and activity.

Customer and project hygiene

Operations teams can keep the project list aligned with the active client roster by reading customers via GET /api/customers, comparing them with the source system, and PATCH-ing project records that need to be archived or relabeled. The endpoint set covers the full project and customer CRUD needed for that sync.

Compare GET /api/customers with the master roster and PATCH /api/projects/{id} to archive any project tied to a deactivated customer.

Invoice export pipeline

Before an invoice run, a script can call PATCH /api/timesheets/{id}/export on every billable entry for a customer so that Kimai marks them as exported and they do not appear on the next run. This keeps the billable-versus-exported state consistent across runs.

List timesheets for a customer over the billing period and PATCH /api/timesheets/{id}/export on each one before generating the invoice.

Agent integration via Jentic

A productivity agent can use Jentic to discover the Kimai timesheet operations, load their schemas, and execute them with a vaulted bearer token, letting a user start, stop, or duplicate entries by speaking to the agent.

Search Jentic for 'stop the running Kimai timesheet', load PATCH /api/timesheets/{id}/stop, and execute it for the authenticated user's active entry.

Key Endpoints

45 endpoints — jentic publishes the only available openapi specification for kimai api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/api/timesheets

List timesheet entries

POST

/api/timesheets

Create a timesheet entry

PATCH

/api/timesheets/{id}/stop

Stop a running timesheet

PATCH

/api/timesheets/{id}/restart

Restart a timesheet

GET

/api/timesheets/active

Get currently running timesheets

GET

/api/projects

List projects

GET

/api/customers

List customers

GET

/api/timesheets

List timesheet entries

POST

/api/timesheets

Create a timesheet entry

PATCH

/api/timesheets/{id}/stop

Stop a running timesheet

PATCH

/api/timesheets/{id}/restart

Restart a timesheet

GET

/api/timesheets/active

Get currently running timesheets

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Kimai bearer token or X-AUTH-TOKEN is stored encrypted in the Jentic vault and injected per request. Agents never read the raw credential or the host URL of a customer's self-hosted instance.

Intent-based discovery

Agents search by intent, for example 'stop the running Kimai timesheet', and Jentic returns the matching PATCH operation with its full path and parameter schema.

Time to first call

Direct integration: about a day to handle the dual auth schemes, host-variable base URL, and pagination across 45 endpoints. Through Jentic: under an hour.

FAQs

Specific to using Kimai API through Jentic.

Why is there no official OpenAPI spec for Kimai API?

The Kimai project does not publish a hosted OpenAPI specification under its own domain. Jentic generates and maintains this spec so that AI agents and developers can call Kimai API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Kimai API use?

Kimai supports two schemes: HTTP bearer authentication and a legacy X-AUTH-TOKEN header. Jentic stores the credential in the vault and injects whichever scheme the instance accepts on each request.

Can I stop a running timesheet with the Kimai API?

Yes. Call PATCH /api/timesheets/{id}/stop on the entry you want to stop. To find the entry, list active timers first with GET /api/timesheets/active.

What are the rate limits for the Kimai API?

Kimai is self-hosted, so the rate limit depends on the instance configuration rather than a public quota. Treat list endpoints as paginated reads and avoid polling /api/timesheets/active more often than once a minute.

How do I create a timesheet entry with the Kimai API through Jentic?

Run pip install jentic, search Jentic for 'create a Kimai timesheet entry', load the POST /api/timesheets operation, and execute it with begin, end, project, and activity. Jentic injects the bearer or X-AUTH-TOKEN credential from the vault.

Kimai API

Connect the Kimai API to your agent

Capabilities

Start building with Kimai API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs