Navigation (menus, bookmarks, pages, filters)Get the system administration menu

Get the system administration menu

Returns the system administration menu for callers allowed into system administration; an empty list for everyone else.

Returns the system administration menu: settings areas (general settings, time and expense registrations, invoicing, ...) with the settings pages the caller may open. Entries carry Type SystemAdministration and their names come from the system-settings resources. A caller who may not access system administration at all gets 200 with an empty list, not 403. Names are always English.

Use it to:

  • Render the system administration navigation for an administrator

Not for:

  • Checking whether a user is an administrator - an empty menu has several causes (licence, roles, a swallowed error)

Behaviour:

  • Idempotent.
  • Safe to retry.

Next: POST /v2/bookmarks

See also: GET /v2/menus/main, GET /v2/menus/create, GET /v2/menus/page-settings, GET /v2/menus/personal-settings, GET /v2/menus/system-administration, GET /v2/pages/design-seven

Not yet documented: behaviour → consistency.

curl -X GET "https://app3.timelog.com/your-account/api/v2/menus/system-administration" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Entities": [
    {
      "Properties": {
        "PageId": "null",
        "Name": "John Doe",
        "Type": "Main",
        "IsParent": true,
        "PageUrl": "null",
        "PageIdentifier": "null",
        "PageType": "null",
        "PageVersion": "null",
        "SubMenus": "null"
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v2/menus/system-administration
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

Entitiesarray

Omitted (not []) when the list is empty.

Linksarray