OperationsHelp centre, public
Read everything the help centre landing page shows
Categories with their sections, plus the promoted articles (FR-63a/g).
/v1/public/help-centre/homeNo credential- Operation id
- get_home
- Access
- Public by design. No credential is required or consulted.
GET
/v1/public/help-centre/homeCategories with their sections, plus the promoted articles (FR-63a/g).
One call for a whole landing page: the site chrome, the top level categories with their sections nested inside them, and the articles staff have promoted to the front.
Categories are ordered by their configured position. The counts on each category are counts of articles a visitor can actually see, so they never promise more than the category will show.
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/home"{ "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" }, "categories": [ { "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": [] } ] } ], "promoted": [ { "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 } ]}