List conversations with the Chatwoot API

Lists conversations of an account, the open ones by default, with status, labels, inbox_id, can_reply, the contact in meta.sender, the assignee and the last message. data.meta has the counts by assignee type. Pages are numbered from 1; an empty payload means there are no more pages.

Identifier
chatwoot_list_conversations

The request

POST https://connect.reportei.com/api/tools/chatwoot_list_conversations/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": 1
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
account_idintegerYesId of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123.
statusstringNoOnly conversations with this status. The default is open.Values: all, open, resolved, pending, snoozed
assignee_typestringNoOnly conversations assigned to the user of the connection, unassigned, assigned to anyone, or all (the default).Values: me, unassigned, all, assigned
qstringNoOnly conversations with messages containing this text.
inbox_idintegerNoOnly conversations of this inbox, from List inboxes.
team_idintegerNoOnly conversations of this team, from List teams.
labelsstringNoOnly conversations with this label. One label per call.
pageintegerNoPage number, starting at 1.

Supported connections

Your customer connects their Chatwoot account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/chatwoot_list_conversations. It becomes your agent's tool definition with no conversion.

Other Chatwoot tools

See all 15 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.