Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Help Center → List Articles

AI-generated

Summary

List articles from a specified help center portal, optionally filtered by locale, category slug, and status, with control over pagination and result limits.

Inputs

  • Portal Slug or ID (required) — The slug or ID of the portal to list articles from.
  • Return All — Whether to return all available articles or limit the number of results.
  • Limit — The maximum number of articles to return when Return All is false.
  • Options — Optional filters including Locale to filter articles by language, Category Slug to restrict by article category, and Status to filter articles by their publication status (Draft, Published, Archived, or All).

Output shape

a list of articles

Results may be paginated according to the Return All and Limit parameters; if Return All is true, all articles matching filters are retrieved across pages. Each article object includes its standard attributes as returned by Chatwoot's Help Center API.

Links

Discussion