Skip to main content
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>'
{
  "matches": [
    {
      "messageId": "67e0a0b0c0d0e0f0a0b0c0d0",
      "createdAt": "2026-05-18T13:30:00.000Z"
    },
    {
      "messageId": "67e0a0b0c0d0e0f0a0b0c0d3",
      "createdAt": "2026-05-18T13:45:00.000Z"
    }
  ],
  "total": 2,
  "truncated": false
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
conversationId
string
required

Query Parameters

​
q
string
required

Search query (regex-escaped server-side)

Required string length: 1 - 500
​
matchCase
boolean
default:false
​
wholeWord
boolean
default:false
​
limit
integer
default:2000
Required range: 1 <= x <= 5000
​
fromDate
string

Inclusive lower bound (UTC), YYYY-MM-DD

Pattern: ^\d{4}-\d{2}-\d{2}$
​
toDate
string

Inclusive upper bound (UTC), YYYY-MM-DD

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Search matches returned

​
matches
object[]
required
​
total
integer
required
​
truncated
boolean
required

True when results were capped at limit