Skip to main content
GET
Search messages within a conversation

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