ChatWoot Application icon

ChatWoot Application

Interact with ChatWoot Application APIs

Actions112

Contact → Contact Filter

AI-generated

Summary

Filter contacts for a specified account by sending a request with optional query parameters and a JSON payload to refine the contacts list.

Inputs

  • Account ID (required) — The numeric ID of the ChatWoot account to filter contacts for.
  • Page — The pagination page number to retrieve, sent as a query parameter.
  • Payload — A JSON object sent as the request body to specify additional filter criteria.

Output shape

a list of contacts matching the filter criteria for the given account

Supports pagination via the 'Page' query parameter; the 'Payload' allows advanced filtering. Returned data depends on the ChatWoot API response schema for filtered contacts.

Links

Discussion