Jump to
Search
Search messages GET
GET /mailboxes/{email_address}/searchSearch messages in a mailbox using Postgres full-text search. Results are ranked by relevance (using ts_rank) and then by recency. Unlike list endpoints, search does not use cursor pagination.
The q parameter is parsed with plainto_tsquery, so plain natural language queries work well (e.g. order confirmation, invoice january).
Path parameters
| Parameter | Type | Description |
|---|---|---|
email_address | string | Email address of the mailbox to search |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search query (1–500 chars) |
limit | integer | No | 50 | Maximum results to return (1–100) |
Response (200)
JSONCode examples
cURLSearch messages (org-wide) GET
GET /searchSearch messages across all mailboxes in your organization. Same full-text search as the mailbox-scoped endpoint, but searches everything at once.
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search query (1–500 chars) |
limit | integer | No | 50 | Maximum results to return (1–100) |
Response (200)
Same response format as the mailbox-scoped search.
Code examples
cURL