Get the REST v1 root document
Returns the build version, the server time zone and a link to every REST v1 controller the caller may use.
The entry point of REST v1 in the TAF (hypermedia) style: Properties tell which TimeLog build answered (IndexRead), and Links list the v1 API one controller at a time, each with its actions. Link semantics (how the list is built, per request): A controller that serves v1 and another version is NOT listed; v2-only controllers are listed by GET /v2. - Rel = the controller class name without "Controller" (e.g. "ContactPerson", "TaskExtended", "ExchangeRate") — a code name, not a resource name; two Rels can share a path (Task and TaskExtended are both /task). - Href = the request URL + "/" + the controller's route prefix without "v{version:apiVersion}/". - Actions = each public action returning IHttpActionResult: Name = the route name (null when the route is unnamed), Method = its first HTTP method attribute, Href = controller Href + "/" + the raw route template (placeholders such as {id:int} are left in; an empty template gives a trailing "/"). - Controllers and actions carrying privilege / page / feature policy attributes are listed only when the caller and account pass those policies, so the link set can differ per user and per account. Versioning: the path segment selects the API version (/v1 here). The root does not list versions; Version in Properties is the TimeLog build, not the API version.
Use it to:
- Smoke test of credentials and connectivity: 200 means the token works on this account
- Record the TimeLog build (Version / ChangeSet) in integration logs for support cases
Not for:
- A machine-readable contract — use the OpenAPI document; Rel names and action Names are code names.
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Next: GET /v1/user/me
Not yet documented: examples (success); response → success.
curl -X GET "https://app3.timelog.com/your-account/api/v1" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1"
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", {
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", 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')
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": {
"Version": "example_string",
"ChangeSet": "example_string",
"ServerTimeZoneId": "example_string"
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1
Target server for requests. Edit to use your own host.
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.
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.Request Preview
Response
Response will appear here after sending the request
Authentication
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.
Responses
The useful part of the root document is its Links array (one link per v1 controller), documented on GET /v1.