Skip to main content
GET
CLI
The match is case-insensitive and covers message text, email subject, sender name and sender address (and the HTML of emails without a text part). Results are threads, newest match first; each thread’s lastMessage is the newest matching message. Without fromDate the last 180 days are searched (searchedFrom in the response).

Use Cases

  • Find a request: every thread where a contact wrote “refund” (query=refund&direction=inbound)
  • Check what you promised: direction=outbound searches what you, your team or your AI sent
To find a thread by the contact’s name, email or phone, use search on List Threads.

Permissions

The API key needs the Inbox permission.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string
required

The words to find, 2 to 200 characters.

Required string length: 2 - 200
channel
enum<string>

Only messages on this channel.

Available options:
whatsapp,
email,
sms,
telegram
direction
enum<string>
default:all

inbound = written by the contact, outbound = sent by you.

Available options:
all,
inbound,
outbound
fromDate
string<date-time>

ISO date. Default: 180 days ago.

toDate
string<date-time>

ISO date.

limit
integer
default:20
Required range: 1 <= x <= 50

Response

Matching threads

data
object