Search help center articles

Searches current Leadtime documentation with hybrid text and semantic ranking.

Use cases:

Build in-product help search
Suggest relevant documentation from API clients
Resolve documentation slugs before fetching article Markdown

What is returned:

Stable documentation slug
Breadcrumb and per-locale titles/descriptions
Available locales
Hybrid relevance score

Use GET /help-center/article with the returned slug to fetch the full article Markdown.

GET/help-center/search

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

searchTermstringrequired

Search term used to find relevant help center articles.

Responses

200Matching help center articles

resultsHelpCenterSearchResultDto[]required

Show properties

Array of HelpCenterSearchResultDto

availableLocalesstring[]required

breadcrumbstring[]required

Documentation path segments above this article.

descriptionsHelpCenterLocalizedValueDtorequired

Show properties

destring

enstring

relevanceScorenumberrequired

Best hybrid search score among localized variants.

slugstringrequired

Stable documentation slug used to retrieve the article.

titlesHelpCenterLocalizedValueDtorequired

Show properties

destring

enstring

searchTermstringrequired

totalResultsnumberrequired

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

502Documentation search request failed upstream

503Help center search is not configured on this server

Request

curl -X GET "https://leadtime.app/api/public/help-center/search?searchTerm=task%20types" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/help-center/search?searchTerm=task%20types", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/help-center/search?searchTerm=task%20types",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "results": [
    {
      "availableLocales": [
        "de",
        "en"
      ],
      "breadcrumb": [
        "administration",
        "task-settings"
      ],
      "descriptions": {
        "de": "Aufgabentypen",
        "en": "Task types"
      },
      "relevanceScore": 0.75,
      "slug": "administration/task-settings/custom-task-types",
      "titles": {
        "de": "Aufgabentypen",
        "en": "Task types"
      }
    }
  ],
  "searchTerm": "task types",
  "totalResults": 2
}