Get help center article content

Fetches the Markdown source of a Leadtime documentation article.

How to use this endpoint:

Call GET /help-center/search to find a matching article
Pass the returned slug to this endpoint
Optionally set language to de or en

What is returned:

Stable slug
Selected language
Complete article Markdown
Breadcrumb and sibling articles
A fallback flag when the requested locale was unavailable

GET/help-center/article

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

slugstringrequired

Documentation slug from the search response.

languagestring

Preferred response language. Defaults to de.

Allowed:deen

Responses

200

Full help center article content

breadcrumbstring[]required

contentstringrequired

The complete article Markdown for the selected language.

fallbackbooleanrequired

Whether the requested language was unavailable and the other locale was returned.

languagestringrequired

Allowed:deen

siblingsHelpCenterSiblingDto[]required

Show properties

Array of HelpCenterSiblingDto

slugstringrequired

titlestringrequired

slugstringrequired

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

500

Unexpected help center integration response

502

Documentation article request failed upstream

503

Help center integration 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

slugquery*Documentation slug from the search response.languagequeryPreferred response language. Defaults to `de`.

Request

curl -X GET "https://leadtime.app/api/public/help-center/article?slug=administration%2Ftask-settings%2Fcustom-task-types" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/help-center/article?slug=administration%2Ftask-settings%2Fcustom-task-types", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/help-center/article?slug=administration%2Ftask-settings%2Fcustom-task-types",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "breadcrumb": [
    "administration",
    "task-settings"
  ],
  "content": "---\ntitle: Benutzerdefinierte Aufgabentypen\n---\n\n...",
  "fallback": false,
  "language": "de",
  "siblings": [
    {
      "slug": "administration/task-settings/task-statuses",
      "title": "Task statuses"
    }
  ],
  "slug": "administration/task-settings/custom-task-types"
}