Get my running time tracker

Returns the calling user's running time tracker, or null when none is running.

Use it to:

Restore a timer UI: show what is being tracked and since when.

Behaviour:

Idempotent.
Safe to retry.
Changes are visible to the next read immediately.

Next: POST /v1/time-registration/stop-time-tracker/{timeTrackerId}, PUT /v1/time-tracker

Not yet documented: examples (populated).

curl -X GET "https://app3.timelog.com/your-account/api/v1/time-tracker/active-time-tracker?$expand=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app3.timelog.com/your-account/api/v1/time-tracker/active-time-tracker?$expand=example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app3.timelog.com/your-account/api/v1/time-tracker/active-time-tracker?$expand=example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v1/time-tracker/active-time-tracker?$expand=example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app3.timelog.com/your-account/api/v1/time-tracker/active-time-tracker?$expand=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "Properties": {
    "TimeTrackerID": 123,
    "ID": "123e4567-e89b-12d3-a456-426614174000",
    "UserID": 123,
    "Date": "2024-12-25T10:00:00Z",
    "StartTime": "2024-12-25T10:00:00Z",
    "EntityType": 42,
    "EntityID": "null",
    "Task": {
      "TaskID": 123,
      "ID": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "John Doe",
      "No": "example_string",
      "IsFixedPrice": true,
      "IsDefaultBillable": true,
      "AdditionalTextIsRequired": true,
      "ParentFullName": "John Doe",
      "ProjectID": 123,
      "Project": {
        "ProjectID": 123,
        "ID": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "John Doe",
        "No": "example_string",
        "ExpenseIsBillable": "null",
        "CustomerID": 123,
        "Customer": {
          "CustomerID": 123,
          "ID": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "John Doe",
          "No": "example_string",
          "DefaultMileageDistance": 25,
          "CustomerStatusID": 123,
          "VATNo": "example_string",
          "OrganizationNo": "example_string"
        },
        "MainContractId": 123
      },
      "ParentTaskID": "null",
      "IsTravelTimeTask": true,
      "IsFavourite": "null"
    },
    "AbsenceCode": {
      "AbsenceCodeID": 123,
      "AbsenceCode": "example_string",
      "Name": "John Doe",
      "Description": "example_string",
      "IsActive": true,
      "FlexPositiveFactor": 3.14,
      "SalaryAccountFactor": 3.14,
      "SalaryAccountFactorEffect": 10,
      "SalaryAccountID": 123,
      "AbsenceCodeTypeID": 123,
      "DeductCapacity": true,
      "TimeTrackingFormat": 42,
      "RequireApproval": true,
      "IsPublicVisible": true,
      "IsFavourite": "null",
      "ID": "123e4567-e89b-12d3-a456-426614174000"
    },
    "TimeRegistrationID": "null",
    "Comment": "example_string",
    "Minute": 42,
    "BillableMinute": 42,
    "IsBillable": "null",
    "TimeTrackerStatus": 42,
    "MonthlyPeriod": "null",
    "AdditionalTextField": "null",
    "Factor": 3.14
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}

GET

/v1/time-tracker/active-time-tracker

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

query

$expandstring

task and/or absenceCode: fills the nested Task / AbsenceCode object. Several values: one string, separated by ,.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Query Parameters

$expandstring

task and/or absenceCode: fills the nested Task / AbsenceCode object.

Several values: one string, separated by ,.

Responses

Propertiesobject

A time tracker (stopwatch) of one employee. A tracker is either running (TimeTrackerStatus 1) or ended but not yet turned into a time registration (TimeTrackerStatus 2). When a tracker is stopped and its data forms a valid registration, the registration is written and the tracker row is deleted, so a tracker is short-lived.

Linksarray

Actionsobject[]

Was this page helpful?