Kimai logo Kimai Docs User manual

Connecting via API

How to connect your Kimai account with applications, requesting your API token and how to use it.

Kimai 2.13.0 2.38.0 (latest version)

How to create an API token

First open your API credentials page:

Open API access from your personal user menu

Then you select Create to create one API token:

Create an API token for Kimai

Bearer token

When calling the API you have to submit the additional Authorization header with every call:

  • Authorization: Bearer xyz - here xyz is the unique API token for that account

API Base URL

All applications will also ask for your Kimai base URL.

While your API is available under /api or as complete URL https://demo.kimai.org/api, the base URL is what you use to access Kimai in your browser: https://demo.kimai.org.

Do not include the trailing slash:

  • Wrong: https://demo.kimai.org/
  • Correct: https://demo.kimai.org
Top