ChatWootInstall

Summary

Filter conversations by sending a JSON filter payload to the ChatWoot API for a specified account and retrieve the filtered conversation results, optionally paginated.

Inputs

• Account Id (required) — The numeric ID of the ChatWoot account to filter conversations for.
• Page — The page number of the paginated results to retrieve (optional).
• Payload (required) — A JSON array defining filter conditions on conversation attributes, including keys, filter operators, values, and logical query operators (AND/OR) between filters.

Output shape

a list of conversation records matching the filters applied

The response contains filtered conversations according to the payload criteria and account id. Pagination is supported with the 'Page' parameter. Errors or empty results depend on API response.

Examples

Example 1: Filter conversations in account ID 123 excluding browser language 'en' and with status 'pending', retrieving page 1.

Set Account Id to 123, Page to 1, and Payload to JSON: [{"attribute_key":"browser_language","filter_operator":"not_eq","values":["en"],"query_operator":"AND"},{"attribute_key":"status","filter_operator":"eq","values":["pending"],"query_operator":null}].