Search documentation in one project

Searches indexed page titles, tags, and plain-text bodies. Results include ranked full tree paths, short escaped excerpts, and the current content identity.

GET/projects/documentation/search

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

projectIdstringrequired

Project UUID or short identifier, such as RHEIN-2.

querystringrequired

max length 200

pageany

min 1 · default: 1

pageSizeany

min 1 · max 50 · default: 20

Responses

200

itemsProjectDocumentationSearchItemDto[]required

Show properties

Array of ProjectDocumentationSearchItemDto

contentEtagstringrequired

Unquoted SHA-256 content identity for the matched page. Send it unchanged for an exact edit.

contentGenerationnumberrequired

min 1

excerptstringrequired

Short HTML-escaped plain-text excerpt.

idstringrequired

pathstringrequired

Full folder and page path.

tagsstring[]required

titlestringrequired

pagenumberrequired

pageSizenumberrequired

totalnumberrequired

400Invalid project identifier, query, or pagination value.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

404The project does not exist or is not accessible.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

Request

curl -X GET "https://leadtime.app/api/public/projects/documentation/search?projectId=RHEIN-2&query=string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/documentation/search?projectId=RHEIN-2&query=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/documentation/search?projectId=RHEIN-2&query=string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "items": [
    {
      "contentEtag": "8e2ffa0587a5c9e89d3a5228fc2b6693b8941588d06a249dd7bfb6b7e8d871a1",
      "contentGeneration": 1,
      "excerpt": "string",
      "id": "string",
      "path": "string",
      "tags": [
        "string"
      ],
      "title": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0
}