Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Search → Search Contacts

AI-generated

Summary

Search contacts in Chatwoot using a query string, optionally returning all matches or limiting the number of results.

Inputs

  • Query (required) — The search string to find matching contacts in Chatwoot.
  • Return All — Whether to retrieve all matching contacts or limit to a specified maximum number.
  • Limit — Maximum number of contacts to return if not returning all results.

Output shape

An array of contact records matching the search query.

If 'Return All' is true, all matching contacts will be returned. Otherwise, up to 'Limit' contacts are returned.

Links

Discussion