Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

Get help center article content

Fetches the Markdown source of a Leadtime documentation article.

How to use this endpoint:

  1. Call GET /help-center/search to find a matching article
  2. Pass the returned slug to this endpoint
  3. 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
or
AuthorizationBearer token (JWT) · headerrequired
Query parameters
slugstringrequired
Documentation slug from the search response.
languagestring
Preferred response language. Defaults to `de`.
Allowed:deen
Responses
200Full 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
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
500Unexpected help center integration response
502Documentation article request failed upstream
503Help center integration is not configured on this server
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"
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"
}