SettingsGet my UI context (language, sign-up button, segmentation)

Get my UI context (language, sign-up button, segmentation)

Returns the caller's language, whether to show the trial sign-up button, and the in-app-guidance segmentation of the caller and account.

Everything is about the CALLER or the caller's account: profile language (LCID + code), the sign-up-button flag, and two string maps used to segment in-app guidance — the user map (name, user name, e-mail, role flags, department, …) and the account map.

Use it to:

Not for:

  • Account time / expense configuration → GET /v1/user-setting (Common service)

Behaviour:

  • Idempotent.
  • Safe to retry.

Not yet documented: behaviour → consistency.

curl -X GET "https://app3.timelog.com/your-account/api/v2/user-settings" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "Language": {
      "Lcid": 123,
      "ShortString": "example_string"
    },
    "ShowSignUpButton": true,
    "CustomerSegmentationUser": {},
    "CustomerSegmentationAccount": {}
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}
GET
/v2/user-settings
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 own UI context: profile language, whether to show the trial sign-up button, and the in-app-guidance (WalkMe) segmentation of the caller and of the account. Everything is about the caller or the caller's account; no other user's data is returned.

Linksarray
Actionsobject[]