Hanzo
OpenapiHelp

Returns the public knowledge base: the help center's Published,…

Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.

GET /v1/help/articles

Addresshttps://api.hanzo.ai/v1/help/articles
MethodGET
Operationget_help_articles
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the public knowledge base: the help center's Published, publicly-visible articles as cards. The org is server-fixed and the status/is_public filter is server-set, so neither the tenant nor the visibility can be widened by the caller. A deployment with no help center answers 404.

Request

2 fields.

FieldInTypeRequiredDescription
categoryquerystringCategory narrows the list to one knowledge-base section, matched against the article's category by exact name.
limitqueryintegerLimit caps how many articles are returned.

Response

StatusBodyMeaning
200helpArticleListok

200 body — 6 fields.

FieldInTypeAlwaysDescription
databodyhelpArticleCard[]Data is the matching Published, public articles, newest write order last — the store's order, not a ranking.
data[].categorybodystringCategory is the name of the knowledge-base section the article sits in, or empty when it is filed under none.
data[].excerptbodystringExcerpt is the short summary the author wrote for listings, or empty.
data[].slugbodystringSlug is the article's stable public identifier and the path segment /v1/help/articles/{slug} addresses it by.
data[].titlebodystringTitle is the article's headline.
data[].updatedAtbodyintegerUpdatedAt is the unix second the article was last written, in the help center's own store.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Help API · All Hanzo APIs · Interactive reference

How is this guide?

On this page