Read one article, or the redirect that reaches it
One article, or the redirect that gets the visitor to it.
/v1/public/help-centre/articles/{slug}No credential- Operation id
- get_article
- Access
- Public by design. No credential is required or consulted.
/v1/public/help-centre/articles/{slug}One article, or the redirect that gets the visitor to it.
Check redirect before rendering. A response carries a redirect or an
article and never both, so a consumer that ignores the redirect has nothing
to render at the stale URL. Send the visitor to location, and use
status to decide whether to cache the move: 301 is permanent, 302 means
the translation may still arrive.
body_html is the sanitised, link-rewritten body and is the only body any
read path serves. The verbatim text imported from another system is never
returned.
Pass container_path when you know where the article should sit. A
mismatch answers with a redirect to the canonical URL, which is what keeps
an article reachable after staff move it between categories.
Resolution is by slug alone, so an article whose category path has changed still resolves and is redirected to its canonical URL rather than 404ing (FR-17). The order is: the slug as given, then a slug this translation used to carry (FR-15), then the same article in another locale (FR-18). A response carries a redirect or an article and never both, so a consumer that ignores the redirect has nothing to render at the stale URL.
Access: no credential.
Path Parameters
length <= 200Query Parameters
Header Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/public/help-centre/articles/string"{ "article": { "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, "body_html": "<h2>Where invoices live</h2><p>Open <strong>Billing</strong> and choose <em>Invoices</em>.</p>", "body_format": "html", "canonical_url": "https://help.northwind.example/help/billing/invoices/download-a-past-invoice", "alternates": [ { "locale": "de-de", "url": "https://help.northwind.example/de-de/help/billing/invoices/alte-rechnung-herunterladen" } ], "previous": { "article_id": "c8e4d9f2-5a3b-4e72-a1b0-6d9f4a2c8e15", "translation_id": "e52d6c9b-3f7a-4024-9b88-0c1d5f3e7a66", "locale": "en-gb", "title": "Update the card we bill", "slug": "update-the-card-we-bill", "excerpt": "Change the payment method on your account.", "container_path": "billing/invoices", "url": "https://help.northwind.example/help/billing/invoices/update-the-card-we-bill", "position": 1, "promoted": false, "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": 12, "vote_sum": 10 }, "next": { "article_id": "c8e4d9f2-5a3b-4e72-a1b0-6d9f4a2c8e15", "translation_id": "e52d6c9b-3f7a-4024-9b88-0c1d5f3e7a66", "locale": "en-gb", "title": "Update the card we bill", "slug": "update-the-card-we-bill", "excerpt": "Change the payment method on your account.", "container_path": "billing/invoices", "url": "https://help.northwind.example/help/billing/invoices/update-the-card-we-bill", "position": 1, "promoted": false, "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": 12, "vote_sum": 10 }, "author_label": "Northwind Support", "labels": [ "billing", "invoices" ], "source_url": "https://northwind.zendesk.example/hc/en-gb/articles/360001234567", "source_created_at": "2026-03-11T08:00:00+00:00", "source_updated_at": "2026-07-30T11:02:14+00:00", "noindex": false }}