Search API

Full-text search over indexed archived emails, powered by Meilisearch.

Search Emails

Search archived emails

GET

/v1/search

Performs a full-text search across indexed archived emails using Meilisearch. Requires search:archive permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Parameters

Query Parameters

keywords*

The search query string.

Type

string

Required

Example"invoice Q4"

page

Page number for pagination.

Type

integer

Example1

Default

1

limit

Number of results per page.

Type

integer

Example10

Default

10

matchingStrategy

Meilisearch matching strategy. last returns results containing at least one keyword; all requires all keywords; frequency sorts by keyword frequency.

Type

string

Valid values

"last""all""frequency"

Default

"last"

Responses

Search results.

Content-Type

application/json

{

  

"hits": [

  

  

{

  

  

}

  

],

  

"total": 42,

  

"page": 1,

  

"limit": 10,

  

"totalPages": 5,

  

"processingTimeMs": 12

}

GET

/v1/search

Playground

Authorization

bearerAuth

Variables

Key

Value

keywords*

page

limit

matchingStrategy

Samples

Powered by VitePress OpenAPI