OperationsHelp centre, public
Search the published articles
Keyword search over this tenant's public, published articles (FR-60).
/v1/public/help-centre/searchNo credential- Operation id
- get_search
- Access
- Public by design. No credential is required or consulted.
GET
/v1/public/help-centre/searchKeyword search over this tenant's public, published articles (FR-60).
q is required and is matched against titles and bodies. Results come back
ranked, highest rank first, with a snippet showing the match in
context. total counts every hit, not just the page returned, so it is
what a "3 results" line should show.
Every hit carries its breadcrumbs, so a result can be shown where it sits in the tree rather than as a bare title (FR-63e).
Only articles a visitor could open are searchable. There is no query that reaches a draft or an internal article, so search cannot leak the title of something the article route would refuse.
Access: no credential.
Query Parameters
q*Q
Length
length <= 200locale?|null
limit?Limit
Range
1 <= value <= 100Default
30offset?Offset
Range
0 <= valueDefault
0Header Parameters
X-Help-Centre-Host?string|null
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/public/help-centre/search?q=string"{ "site": { "name": "Northwind Support", "default_locale": "en-gb", "locale": "en-gb", "locales": [ "en-gb", "de-de" ], "brand": { "logo_url": "https://cdn.northwind.example/logo.svg", "colour": "#0f1522", "title": "Northwind Support" }, "path_prefix": "/help", "home_url": "https://help.northwind.example/help", "search_url": "https://help.northwind.example/help/search" }, "query": "invoice", "total": 3, "limit": 30, "offset": 0, "results": [ { "article_id": "b7d3c8e1-4f2a-4d61-b0a9-5c8e3f1d7a04", "translation_id": "d41c5b8a-2e69-4f13-8a77-9b0c4e2d6f55", "locale": "en-gb", "title": "Download a past invoice", "slug": "download-a-past-invoice", "excerpt": "Every invoice stays available for seven years.", "container_path": "billing/invoices", "url": "https://help.northwind.example/help/billing/invoices/download-a-past-invoice", "position": 0, "promoted": true, "breadcrumbs": [ { "name": "Billing", "path": "billing", "url": "https://help.northwind.example/help/billing" }, { "name": "Invoices", "path": "billing/invoices", "url": "https://help.northwind.example/help/billing/invoices" } ], "updated_at": "2026-07-30T11:02:14+00:00", "published_at": "2026-03-11T08:00:00+00:00", "vote_count": 41, "vote_sum": 33, "rank": 0.87, "snippet": "Every <mark>invoice</mark> stays available for seven years." } ]}