Search messages within a conversation
curl --request GET \
--url https://your-instance.example.com/api/conversation/{conversationId}/messages/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/conversation/{conversationId}/messages/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/conversation/{conversationId}/messages/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/conversation/{conversationId}/messages/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/conversation/{conversationId}/messages/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/conversation/{conversationId}/messages/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/conversation/{conversationId}/messages/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"matches": [
{
"messageId": "67e0a0b0c0d0e0f0a0b0c0d0",
"createdAt": "2026-05-18T13:30:00.000Z"
},
{
"messageId": "67e0a0b0c0d0e0f0a0b0c0d3",
"createdAt": "2026-05-18T13:45:00.000Z"
}
],
"total": 2,
"truncated": false
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Conversations
Search messages within a conversation
Returns { messageId, createdAt } for each body field regex match in the conversation, plus a total count and truncation flag. Backs the in-conversation find bar — does not return message bodies. Email messages whose content lives only in emailMetadata.bodyHtml will not match.
GET
/
api
/
conversation
/
{conversationId}
/
messages
/
search
Search messages within a conversation
curl --request GET \
--url https://your-instance.example.com/api/conversation/{conversationId}/messages/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-instance.example.com/api/conversation/{conversationId}/messages/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/api/conversation/{conversationId}/messages/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/api/conversation/{conversationId}/messages/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/conversation/{conversationId}/messages/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-instance.example.com/api/conversation/{conversationId}/messages/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/conversation/{conversationId}/messages/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"matches": [
{
"messageId": "67e0a0b0c0d0e0f0a0b0c0d0",
"createdAt": "2026-05-18T13:30:00.000Z"
},
{
"messageId": "67e0a0b0c0d0e0f0a0b0c0d3",
"createdAt": "2026-05-18T13:45:00.000Z"
}
],
"total": 2,
"truncated": false
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Search query (regex-escaped server-side)
Required string length:
1 - 500Required range:
1 <= x <= 5000Inclusive lower bound (UTC), YYYY-MM-DD
Pattern:
^\d{4}-\d{2}-\d{2}$Inclusive upper bound (UTC), YYYY-MM-DD
Pattern:
^\d{4}-\d{2}-\d{2}$