Chatwoot icon

Chatwoot

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

Actions206

Contact → Filter

AI-generated

Summary

Filter contacts in Chatwoot using flexible, JSON-defined filter conditions and control the number of results returned.

Inputs

  • Return All — Boolean toggle to return all filtered contacts or limit the number of results.
  • Limit — Maximum number of contacts to return when 'Return All' is false (1-100).
  • Filter Payload (required) — A JSON array defining the filter criteria with objects specifying attribute_key, filter_operator, and values.

Output shape

a list of contact objects matching the filter criteria, limited by the input parameters

If 'Return All' is true, all matching contacts are returned; otherwise, results are capped by the 'Limit' value. Filter conditions must be a valid JSON array describing attribute filters.

Links

Discussion