Skip to main content

Search Help Docs

GET 
/api/support/agent/docs/search

Searches the published help documentation for sections an agent can quote or link in a reply. The agent-side twin of Get Support Deflection Suggestions: the same search, but central (no tenant context) and documentation only — it never looks at other customers' tickets.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Query parameters

  • q (required, string, 3–500 characters) — what to search for
  • limit (optional, integer, 1–10, default 6) — maximum sections to return

Response fields (data[], best match first)

  • title (string) — the document title, with the section appended when the match is to a section
  • url (string) — the public documentation URL
  • snippet (string, max 240 characters) — the matching text
  • score (number, 0–1) — relative confidence; a confident match set starts at 1.0, a weaker one at 0.5

data is an empty array when nothing matches or the documentation index is temporarily unavailable — never an error.

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type