OperationsHelp centre, public
Read the full category and section tree
The whole visible tree, for the navigation shown on every page.
/v1/public/help-centre/navigationNo credential- Operation id
- get_navigation
- Access
- Public by design. No credential is required or consulted.
GET
/v1/public/help-centre/navigationThe whole visible tree, for the navigation shown on every page.
The same tree /home carries, without the promoted articles, for a
navigation component that renders on every page and wants one call it can
cache.
Containers whose subtree holds nothing this requester may see are absent. Not empty, absent (FR-39). An empty category in the response is a real category with visible articles further down, so there is never a dead link into a page with nothing on it.
Access: no credential.
Query Parameters
locale?|null
Header Parameters
X-Help-Centre-Host?string|null
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/public/help-centre/navigation"{ "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" }, "tree": [ { "id": "2f8a1d40-9b5e-4a72-8c3d-1e7f6a0b9c22", "kind": "category", "name": "Billing", "description": "Plans, invoices and payment methods.", "slug": "billing", "path": "billing", "url": "https://help.northwind.example/help/billing", "position": 0, "article_count": 2, "total_article_count": 8, "children": [ { "id": "6c1f9a2e-77b4-4c3a-9f21-0d5a2b8e4411", "kind": "section", "name": "Invoices", "description": "Reading, downloading and correcting an invoice.", "slug": "invoices", "path": "billing/invoices", "url": "https://help.northwind.example/help/billing/invoices", "position": 1, "article_count": 6, "total_article_count": 6, "children": [] } ] } ]}