Get Help Center Template
helpcenter_get_templateRead a help center's current design (the draft): its status, the Template Editor link for the customer to review, and an outline of every page — or one part of the draft in full.
A help center's design is its v2 template: theme tokens (colours for light and dark mode, fonts, radius, density), six page kinds (home, category, article, search, contact, notFound), each built from six regions (header, hero, sidebar, main, footer, utility) holding ordered components, plus a global navigation menu, custom CSS and scripts. You edit a DRAFT — the same draft the dashboard's Template Editor opens, with a live preview — and nothing reaches visitors until helpcenter_publish_template. Only v2 help centers can be edited: a classic (v1) one answers template_migration_required, and migrating is the owner's decision, made in the dashboard.
Start here. The outline (the default) gives every component's id and type with only the settings that differ from their defaults, the theme, brand and meta in full, and indexes of navigation, scripts and custom CSS — enough to plan an edit without reading the whole document. Then read the part you are about to change in full: section 'component' with its id, 'page', 'region', a CSS block or script by id.
It also returns the draft's etag: pass it to an edit tool or to helpcenter_publish_template to be refused (instead of silently overwriting) if someone changed the draft meanwhile — a person may be editing it in the Template Editor at the same time.
Args:
section: 'outline' (default) | 'document' | 'brand' | 'theme' | 'meta' | 'navigation' | 'scripts' | 'custom_css' | 'page' | 'region' | 'component' | 'translations'.
page / region / id: for the 'page', 'region', 'component', 'custom_css' and 'scripts' sections.
response_format ('markdown' | 'json'): default 'markdown'.
Errors: 409 template_migration_required for a classic (v1) help center; 404 for an unknown component, CSS or script id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Component / CSS block / script id, for those sections. | |
| page | No | Page kind: home, category, article, search, contact or notFound. | |
| region | No | Region of the page: header, hero, sidebar, main, footer or utility. | |
| section | No | 'outline' (default: status, links and a compact map of the draft — every component id, and only settings that differ from their defaults), or one part of the draft document: 'page' (with page), 'region' (with page and region), 'component' (with id), 'custom_css' / 'scripts' (all, or one with id), 'brand', 'theme', 'meta', 'navigation', 'translations', or the whole 'document' (large — prefer parts). | outline |
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |