Chatwoot icon

Chatwoot

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

Actions206

Conversation → Filter

AI-generated

Summary

Retrieve a filtered list of conversations matching specified filter conditions, optionally limited to a maximum number of results.

Inputs

  • Return All — Boolean flag to choose whether to return all matching conversations or limit the number of results.
  • Limit — Maximum number of conversations to return when not returning all results; must be between 1 and 100.
  • Filter Payload (required) — JSON array specifying filter conditions as objects containing attribute key, filter operator, and values to filter conversations by.

Output shape

A list of conversation records matching the filter criteria.

If 'Return All' is true, all matching conversations are returned; otherwise, up to 'Limit' number of conversations are returned. The filter conditions must be supplied as a JSON array describing attribute filters.

Examples

Example 1: Filter conversations with status 'open' and return up to 50 results.

Set 'Return All' to false, 'Limit' to 50, and 'Filter Payload' to [{"attribute_key": "status", "filter_operator": "equal_to", "values": ["open"]}].

Example 2: Return all conversations assigned to a specific agent.

Set 'Return All' to true and 'Filter Payload' to filter on the 'agent_id' attribute with the appropriate operator and value.

Links

Discussion