SettingsList my front-page widgets

List my front-page widgets

Returns the calling user's front-page widgets in their personal display order.

The widgets the caller sees on the front page, first to last. A widget is listed only when one of the caller's roles grants the widget page AND it appears in the caller's stored widget order (front-page setting PersonalWidgetSettings, "{pageId}:{position};…"). Each item gives the widget's page id (the id to send to PATCH displayorder) and its PageIdentifier name.

Use it to:

  • Render the caller's front-page widgets in order; get WidgetID values for reordering

Not for:

  • Which widget features the account has on → GET /v2/features/front-page

Behaviour:

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

Next: PATCH /v2/page-settings/widgets/displayorder

See also: GET /v2/features/front-page

curl -X GET "https://app3.timelog.com/your-account/api/v2/page-settings/widgets" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "WidgetList": [
      {
        "WidgetID": 1156,
        "WidgetName": "WidgetTimeTrackingDelay"
      },
      {
        "WidgetID": 1161,
        "WidgetName": "WidgetBillablePercentage"
      },
      {
        "WidgetID": 1162,
        "WidgetName": "WidgetExternalPercentage"
      },
      {
        "WidgetID": 1163,
        "WidgetName": "WidgetPersonalPlan"
      },
      {
        "WidgetID": 1160,
        "WidgetName": "WidgetHourKPIHoursOnly"
      },
      {
        "WidgetID": 1158,
        "WidgetName": "WidgetHourKPI"
      },
      {
        "WidgetID": 1159,
        "WidgetName": "WidgetHourKPIWithBAR"
      },
      {
        "WidgetID": 1152,
        "WidgetName": "WidgetInvoicedPerMonth"
      },
      {
        "WidgetID": 1155,
        "WidgetName": "WidgetAverageHourlyRate"
      },
      {
        "WidgetID": 1151,
        "WidgetName": "WidgetPlannedAbsence"
      },
      {
        "WidgetID": 1154,
        "WidgetName": "WidgetProjectEconomyHealth"
      },
      {
        "WidgetID": 1157,
        "WidgetName": "WidgetVacationCalculation"
      }
    ]
  },
  "Links": [
    {
      "Href": "https://app{server-number}.timelog.com/{account}/api/v2/page-settings/widgets",
      "Rel": "self"
    }
  ]
}
GET
/v2/page-settings/widgets
GET
Base URLstring

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

Bearer Token
Bearer Tokenstring
Required

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.

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.
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.

Responses

Propertiesobject

The caller's front-page widgets in the caller's personal display order (a single TAF object).

Linksarray
Actionsobject[]