AuralisDocs
OperationsHelp centre, public

List every indexable URL

Every URL that may be indexed, and by construction only those (FR-61).

/v1/public/help-centre/sitemapNo credential
Operation id
get_sitemap
Access
Public by design. No credential is required or consulted.
GET/v1/public/help-centre/sitemap

Every URL that may be indexed, and by construction only those (FR-61).

Build a sitemap.xml from this. Each entry carries the URL, its locale, the time it last changed, and whether it is the home page, a container or an article.

A non-public or unpublished article cannot appear here for the same reason it cannot be fetched: the query that would have to produce it does not exist. There is no paging, so one call is the whole sitemap for the requested locale.

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/sitemap"
{  "locale": "en-gb",  "entries": [    {      "url": "https://help.northwind.example/help",      "locale": "en-gb",      "last_modified": "2026-07-30T11:02:14+00:00",      "kind": "home"    },    {      "url": "https://help.northwind.example/help/billing",      "locale": "en-gb",      "last_modified": "2026-06-02T16:40:00+00:00",      "kind": "container"    },    {      "url": "https://help.northwind.example/help/billing/invoices/download-a-past-invoice",      "locale": "en-gb",      "last_modified": "2026-07-30T11:02:14+00:00",      "kind": "article"    }  ]}