Read a help centre's name, branding and locales

Name, branding and available locales. No content, so nothing to filter.

Start here when you are rendering a help centre yourself. It gives the chrome: what the site is called, its brand blob, the locales it publishes in, and the URLs the other operations produce links against.

Every operation in this group resolves the help centre from the host the request arrives on, so no credential and no workspace identifier is needed or accepted. A host that matches no enabled help centre answers 404, which is the same answer as content that exists but is not public.

locale picks a translation. An unavailable one falls back to the site's default rather than failing.

Access: no credential.

Query Parameters

Header Parameters

Response Body

curl -X GET "https://example.com/v1/public/help-centre/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"}