Chatwoot icon

Chatwoot

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

Actions206

Conversation → Search

AI-generated

Summary

Search for conversations matching a specified query string, returning either all results or a limited subset as specified.

Inputs

  • Query (required) — A string representing the search query to filter conversations.
  • Return All — Boolean flag to decide whether to return all matching results or limit the output.
  • Limit — Maximum number of search results to return when Return All is false; minimum value is 1.

Output shape

A list of conversation records matching the query, with the list size controlled by the Return All and Limit parameters.

If Return All is true, all matching conversations are returned; if false, only up to the specified Limit (default 25) are returned.

Examples

Example 1: Find all conversations containing 'urgent'

Set Query to 'urgent' and Return All to true.

Example 2: Retrieve up to 10 conversations about 'billing'

Set Query to 'billing', Return All to false, and Limit to 10.

Links

Discussion