ChatWoot Application icon

ChatWoot Application

Interact with ChatWoot Application APIs

Actions112

Conversation → Get Conversation Counts

AI-generated

Summary

Retrieve counts of conversations in a specified ChatWoot account, optionally filtered by inbox, labels, search term, status, or team.

Inputs

  • Account ID (required) — The numeric ID of the ChatWoot account to fetch conversation counts from.
  • Inbox ID — Filter conversation counts by a specific inbox within the account.
  • Labels — Filter conversation counts by specific labels in JSON format.
  • Q — Filter conversation counts by conversations containing messages with this search term.
  • Status — Filter conversation counts by their status (all, open, pending, resolved, snoozed). Defaults to 'all'.
  • Team ID — Filter conversation counts by a specific team ID.

Output shape

a single object containing counts of conversations matching the query parameters for the given account

The response returns aggregated counts for the specified filters; pagination is not applicable as this is a counts endpoint. Optional query parameters narrow down the counts returned.

Examples

Example 1: Count all conversations for a specific account

Set 'Account ID' to the target account and leave all optional filters empty or at defaults.

Example 2: Count conversations filtered by inbox and status

Set 'Account ID' and provide 'Inbox ID' and select desired 'Status' such as 'open'.

Links

Discussion