ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Contacts → Contact Filter

AI-generated

Summary

Filter contacts in a specified ChatWoot account using custom attribute-based criteria with pagination.

Inputs

  • Account Id (required) — The numeric ID of the ChatWoot account to filter contacts from.
  • Page — The page number of results to retrieve, used for paginated responses.
  • Payload (required) — A JSON array defining the filter conditions, where each condition includes an attribute key, a filter operator, values, and a query operator to combine multiple conditions.
  • Request Options — Additional HTTP request options including batching configuration, SSL validation override, proxy settings, and request timeout.

Output shape

a list of contacts matching the specified filters for the given account and page.

The response is paginated and requires 'page' input to retrieve subsequent result sets. The 'payload' input must be a valid JSON array specifying the filter criteria. Request options affect the behavior of the HTTP requests but do not alter the data returned.

Discussion