Read the full category tree, including empty containers
The whole container tree, including containers with nothing visible in them.
/v1/help-centre/treeViewer- Operation id
- get_tree
- Access
- Any workspace role can call this.
/v1/help-centre/treeThe whole container tree, including containers with nothing visible in them.
This is the staff view of the same tree the public site renders. The public
one hides a container with nothing a visitor may see. This one shows it,
because an operator needs to know it is there in order to fix it, and each
node also carries its visibility.
locale picks a translation and defaults to the help centre's own default.
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
Query Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/help-centre/tree"{ "help_centre_id": "string", "locale": "string", "tree": [ { "id": "string", "parent_id": "string", "kind": "string", "name": "string", "description": "string", "slug": "string", "path": "string", "url": "string", "position": 0, "visibility": "string", "article_count": 0, "total_article_count": 0, "children": [ {} ] } ]}