ChatwootInstall

Summary

Search contacts by a query string matching name, email, phone number, or identifier, optionally returning all or a limited number of sorted results.

Inputs

• Query (required) — The search query to find contacts by name, email, phone number, or identifier.
• Return All — Whether to return all matching contacts or limit the number of results.
• Limit — The maximum number of contacts to return when 'Return All' is false; value between 1 and 100.
• Options.Sort By — Field to sort the contacts by, with ascending or descending order indicated by prefix '-'.

Output shape

a list of contact objects matching the search criteria

Results are either all matching contacts or up to the specified limit when 'Return All' is false. Sorting applies as per selected field and direction. Returned data contains contact details relevant from Chatwoot's contact model.

Examples

Example 1: Find contacts matching 'john@example.com' sorted by email ascending, limited to 50 results.

Set 'Query' to 'john@example.com', 'Return All' to false, and 'Limit' to 50, with 'Sort By' set to 'email'.

Links

• n8n community nodes installation guide