List my front-page widgets
Returns the caller's widgets as WidgetType names, first to last. A widget is included only when one of the caller's ACTIVE roles is mapped to its widget page, the page is enabled for the account (system page validation), AND the widget is listed in the caller's personal widget order (front-page setting PersonalWidgetSettings, "pageId:order;…"). New users get that setting from the account setting DefaultPersonalWidgetSettingsForNewUsers, whose seed lists 12 widgets — not OverdueInvoices and not BudgetRemaining — so a role-granted widget missing from the user's personal order is not returned. A user with no role-granted widget gets an empty WidgetList. IsReportWidgetActive is always true.
Use it to:
- Decide which widget-data routes to call for the current user, in display order
Not for:
- The widgets of another user, or the role ↔ widget mapping (admin) — not in this unit
Behaviour:
- Idempotent.
- Safe to retry.
- Changes are visible to the next read immediately.
Next: GET /v2/widget-data/billable-percentage, GET /v2/widget-data/external-percentage
curl -X GET "https://app3.timelog.com/your-account/api/v2/widget/all-active-widgets" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v2/widget/all-active-widgets"
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/v2/widget/all-active-widgets", {
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/v2/widget/all-active-widgets", 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/v2/widget/all-active-widgets')
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": {
"WidgetList": [
{
"Type": "OverdueInvoices"
}
],
"IsReportWidgetActive": true
},
"Links": [
{
"Href": "example_string",
"Rel": "example_string"
}
],
"Actions": [
{}
]
}
{
"Message": "Authorization has been denied for this request."
}
{
"Code": 100,
"Message": "Unknown error occur in system, please contact system administrator.",
"Details": [],
"Parameters": "…",
"Url": "https://app{server-number}.timelog.com/{account}/api/v2/widget/all-active-widgets"
}
/v2/widget/all-active-widgets
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.
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.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.