List the help centres and the ids every other operation here needs
Every help centre this workspace owns, with its hosts and its counts.
/v1/help-centre/centresViewer- Operation id
- get_centres
- Access
- Any workspace role can call this.
/v1/help-centre/centresEvery help centre this workspace owns, with its hosts and its counts.
Start here. Every other operation in this group takes a help_centre_id,
and this is where the ids come from. A workspace with exactly one help
centre can leave that parameter off everywhere.
article_count is everything, including drafts and internal articles.
published_public_count is the subset a visitor could actually read, so
the gap between the two is what is not live.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the help-centre-staff:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/help-centre/centres"{ "help_centres": [ { "id": "string", "name": "string", "default_locale": "string", "enabled": true, "brand": {}, "locales": [ "string" ], "hosts": [ { "subdomain_label": "string", "full_host": "string", "is_primary": true, "verified_at": "2019-08-24T14:15:22Z" } ], "article_count": 0, "published_public_count": 0 } ]}