Skip to content

List messages

GET
/api/v1/messages

Returns messages ordered by created_at descending (newest first). Use limit and offset for pagination. total reflects the count before pagination is applied.

Parameters

Query Parameters

q

Full-text search query (matches subject, body, sender, recipients)

Type
string
limit

Maximum number of results to return

Type
integer
Minimum
1
Maximum
1000
Default
50
offset

Number of results to skip (for pagination)

Type
integer
Minimum
0
Default
0

Responses

Paginated list of message summaries

application/json
JSON
{
  
"messages": [
  
  
{
  
  
  
"id": "01HZ9RQABCDEFGHJKMNPQRSTUV",
  
  
  
"sender": "alice@example.com",
  
  
  
"recipients": "["bob@example.com","carol@example.com"]",
  
  
  
"subject": "Hello world",
  
  
  
"size": 1024,
  
  
  
"has_attachments": false,
  
  
  
"is_read": false,
  
  
  
"is_starred": false,
  
  
  
"tags": [
  
  
  
  
[
  
  
  
  
]
  
  
  
],
  
  
  
"created_at": "2026-03-21T10:00:00Z"
  
  
}
  
],
  
"total": 120
}

Playground

Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Released under the MIT / Apache 2.0 License.