Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Request body for searching messages with full-text query and optional filters

query
string
required

Full-text search query matched against subject, body, and addresses. Supports web-search syntax: bare words are AND-ed (invoice overdue), "quoted phrases" match in order, -word excludes, and or alternates (invoice or receipt). Words are stemmed, so approving matches approval. Results are ranked by relevance, with subject matches weighted above body matches above address matches. For meaning-based rather than keyword matching, use POST /messages/search/semantic instead.

Minimum string length: 1
filters
object

Optional filters to narrow search results

pagination
object

Pagination parameters for the search results

Response

200 - application/json

OK

Ranked, paginated full-text search results

items
object[]
required

Matching messages, most relevant first (not most recent first)

pagination
object
required

Pagination metadata for retrieving additional pages