ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Custom Filters → List All Filters

AI-generated

Summary

List all custom filters for a specified ChatWoot account, optionally filtered by filter type.

Inputs

  • Account Id (required) — The numeric ID of the account for which to list custom filters.
  • Filter Type — The type of custom filter to list; can be 'conversation', 'contact', or 'report'. Defaults to 'conversation'.

Output shape

a JSON array containing all custom filters matching the specified account and filter type

The output includes all filters for the account; the filter_type query parameter limits the results to that type. Request options such as batching, proxy, timeout, and SSL handling can be configured but do not affect the output shape.

Examples

Example 1: List all conversation filters for account 12345

Set Account Id to 12345 and Filter Type to 'Conversation' (default) to retrieve all conversation filters for the specified account.

Discussion