Get the front-page internal message
Returns the administrator's front-page notice (HTML) and whether the caller may edit it.
The FrontPageInternalMessage account setting: rich-text HTML that an administrator writes for every user's front page. IsEditable tells the client whether to offer the editor (front-page privilege). The message is returned even when the feature FrontPageInternalMessage is off — clients should check the feature (GET /v2/features/front-page) before showing the box.
Use it to:
- Front page rendering the administrator's notice; deciding whether to show the edit button
Not for:
- Saving the message →
PUT /v2/settings/{settingIdentifier}(settingIdentifier FrontPageInternalMessage)
Behaviour:
- Idempotent.
- Safe to retry.
Call first: GET /v2/features/front-page
Next: POST /v2/settings/frontpage-image, PUT /v2/settings/{settingIdentifier}
Not yet documented: response → success.
curl -X GET "https://app3.timelog.com/your-account/api/v2/settings/frontpage-internal-message" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v2/settings/frontpage-internal-message"
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/settings/frontpage-internal-message", {
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/settings/frontpage-internal-message", 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/settings/frontpage-internal-message')
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": {
"Name": "FrontPageInternalMessage",
"Value": "<h1 style="">_TIMJenm70519EUR (.0058)<br><br><br>1234567890<br>ABCDEFGHIJKLMNOPQRSTUVWXYZ</h1><p style=""> a</p>",
"IsEditable": true
},
"Links": [
{
"Href": "https://app{server-number}.timelog.com/{account}/api/v2/settings/frontpage-internal-message",
"Rel": "self"
}
]
}
{
"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"
}
/v2/settings/frontpage-internal-message
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
One account setting's value, plus whether the CALLER may change it. Today only the front-page internal message is served this way.