timr REST API

With the timr REST API, you connect your existing data infrastructure – such as a database, ticket system, issue tracking, or ERP/CRM software – directly to timr and keep your data in sync automatically, with no manual transfer. Using the API is included in all paid timr plans.
 

What the REST API offers

You can access the following data, among others:

• Employees, teams, and work time models
• Working times and project times
• Tasks including assignments
• Drive log (drives, vehicles, categories)

You can find a complete overview of all endpoints in our developer documentation: https://developer.timr.com/
The API base URL is https://api.timr.com/v1.
 

Tip: Follow all releases and changes to the API in the changelog: https://github.com/troii/timr-api/releases

Requirements

• You need administrator rights in timr.
• Decide in advance which grant type to use: client_credentials (machine-to-machine, without user login) or authorization_code (with user login). Learn more about grant types here: Choosing the right grant type
• For the Authorization Code Flow, you need at least one absolute redirect URL.
   

How to create your API access credentials

1. Open the timr web application.
2. Go to Administration → Settings → Integrations.
3. Under API Credentials, click + Add.
4. Enter a name and select the grant type.
5. Click Save.

You will then receive an OAuth Client ID and an OAuth Client Secret.

Note: Keep the Client Secret in a safe place – it contains sensitive information of your employees.

The REST API authenticates via OAuth2. For detailed information on grant types, scopes, the token endpoint, and example requests, see the article OAuth2 authentication for the timr REST API.
 

SDKs and OpenAPI specification

Official SDKs and the complete OpenAPI specification are available for the REST API. They let you connect timr to your own applications faster, with ready-made clients and matching data models.

The timr API repository is publicly available: https://github.com/troii/timr-api

It contains:

• the OpenAPI specification (current version 1.0.0)
• SDKs for Java (Spring RestClient and RestTemplate), Kotlin, .NET, TypeScript, and Python

You can find installation and package links in the Client SDKs section of the repository: https://github.com/troii/timr-api#client-sdks

If you have any questions about the API, contact us at info@timr.com.

Further integration options

Note: If you want to connect timr without any programming of your own, you can use timrLink. It lets you define, through a simple configuration, which entities of your infrastructure are synchronized with timr and on which schedule. Contact us for timrLink pricing. 

For existing integrations, the SOAP API remains available; it is no longer being developed and is described in the article timr SOAP API (Legacy).