Skip to main content
GET
Search messages across all conversations for a contact

Authorizations

Authorization
string
header
required

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

Path Parameters

contactId
string
required

Query Parameters

q
string
required
Required string length: 1 - 500
matchCase
boolean
default:false
wholeWord
boolean
default:false
channelType
string

Single channel or comma-separated list (e.g. "sms,email")

fromDate
string
Pattern: ^\d{4}-\d{2}-\d{2}$
toDate
string
Pattern: ^\d{4}-\d{2}-\d{2}$
limit
integer
default:2000
Required range: 1 <= x <= 5000

Response

Grouped search results returned

results
object[]
required
total
integer
required
truncated
boolean
required