Get user settings
Returns the account settings a time/expense client needs (duration format, billable and stopwatch features, system currency, approval mode …) plus a few caller-specific flags.
One object, no parameters. Call it once at client start-up to decide which fields to show and which operations will work — e.g. StopwatchTimeTracking before using the time-tracker operations, SiteSettings.ShowUserDefinedComment / UserDefinedCommentName before sending an additional text field, CanUseTravelTimeTask before sending GroupType 6. Despite the name, almost everything is account-wide; only SystemCurrencyRate, Privileges.RegistrationAllTasks and SiteSettings.TimeRegistrationTimestamp depend on the caller.
Use it to:
- Feature-detect a account before enabling time-tracker or travel-time flows
- Format durations and numbers the way the account's users see them
Not for:
- The caller's personal preferences (language, views) — see REST v2 /user-settings
Behaviour:
- Idempotent.
- Safe to retry.
Next: POST /v1/time-registration, POST /v1/time-tracker/task/start-time-tracker
See also: GET /v1/currency/{status}
Not yet documented: behaviour → consistency.
curl -X GET "https://app3.timelog.com/your-account/api/v1/user-setting" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/user-setting"
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/user-setting", {
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/user-setting", 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/user-setting')
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": {
"CompanyName": "John Doe",
"NumberCultureID": 123,
"TimeFormat": 42,
"TimeRoundingFormat": 42,
"BillableHourIsEditable": true,
"BillableHourIsEditableOnFixedPrice": true,
"ShowBillableCheckbox": true,
"StopwatchTimeTracking": true,
"SystemCurrencyID": 123,
"SystemCurrencyRate": 3.14,
"SystemCurrencyABB": "example_string",
"IsAbsenceActive": true,
"RoundingOfBillableTime": true,
"IsMLEActive": true,
"Privileges": {
"RegistrationAllTasks": true,
"ExpenseTravelRegistrationAllProjects": true
},
"SiteSettings": {
"TreatAllTimeRegistrationAsRecurringTask": true,
"TaskNumber": true,
"ShowOdometer": true,
"OdometerIsRequired": true,
"CanUseTravelTimeTask": true,
"FileAttachmentInExpense": true,
"ShowUserDefinedComment": true,
"UserDefinedCommentName": "John Doe",
"UserDefinedCommentDataType": "TypeNotSet",
"UseTimeRegistrationFinancialDataService": true,
"TimeTrackingWarning": 42,
"TimeRegistrationTimestamp": true,
"ShowWarningWhenTimestampOverlap": true,
"ApprovalFlows": true,
"ProjectManagerApproval": true,
"EnhancedTimesheetApprovals": true,
"CommentIsMandatory": true,
"ShowExpenseCurrency": true
}
},
"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/user-setting
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
A snapshot of the account configuration that a time/expense client needs to render its UI correctly, plus three caller-specific values (SystemCurrencyRate, Privileges.RegistrationAllTasks, SiteSettings.TimeRegistrationTimestamp). Read-only, one object per call.