Skip to main content
Full command reference. New here? Start with Getting started. For output formats and automation, see Scripting & output.

Grammar at a glance

  • Plural noun = list: chatwoot convs, chatwoot contacts, chatwoot agents
  • Singular + id = view: chatwoot conv 123 shows conversation 123
  • Singular + id + verb = act: chatwoot conv 123 reply "thanks" — id before verb, the way you’d say it
Verb-first form (chatwoot conv reply 123 "thanks") also works.

Conversations

List

Act on one

Reply:
Status:
Assignment:
Labels & priority:
Contact:

Contacts

Inboxes, agents, labels, teams

Help centers

hc articles uses the saved default help center and locale. Pass --portal or --locale when you want to override them for one command.

Profile

Raw API

Use chatwoot api for authenticated API calls that do not have a first-class CLI command yet. Account-relative paths are expanded under /api/v1/accounts/<account_id>, so do not include the /api/v1/accounts/... prefix.
Use the application Swagger as the endpoint reference before raw API calls: application_swagger.json.

Auth & config

Version

Global flags

For pipelines and exports using these flags, see Scripting & output.