Get the help center table of contents

Returns the documentation structure as breadcrumb groups with stable slugs, localized titles, and locale availability. Optionally scope the response to one subtree with rootPath.

GET/help-center/toc

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

rootPathstring

Optional documentation subtree path.

Responses

200

Help center documentation structure

groupsHelpCenterTocGroupDto[]required

Show properties

Array of HelpCenterTocGroupDto

articlesHelpCenterTocArticleDto[]required

Show properties

Array of HelpCenterTocArticleDto

availableLocalesstring[]required

slugstringrequired

titlesHelpCenterLocalizedValueDtorequired

Show properties

destring

enstring

breadcrumbstring[]required

rootPathstring

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

502

Documentation structure request failed upstream

503

Help center search is not configured on this server

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

rootPathqueryOptional documentation subtree path.

Request

curl -X GET "https://leadtime.app/api/public/help-center/toc" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/help-center/toc", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/help-center/toc",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "groups": [
    {
      "articles": [
        {
          "availableLocales": [
            "de",
            "en"
          ],
          "slug": "administration/task-settings/custom-task-types",
          "titles": {
            "de": "Aufgabentypen",
            "en": "Task types"
          }
        }
      ],
      "breadcrumb": [
        "administration",
        "task-settings"
      ]
    }
  ],
  "rootPath": "administration/task-settings"
}