GET
/
v1
/
mail
/
messages
curl --request GET \
  --url http://localhost:8000/api/v1/mail/messages
{
  "data": [
    {
      "id": "<string>",
      "body": "<string>",
      "html_body": "<string>",
      "user_id": "<string>",
      "date": "<string>",
      "snippet": "<string>",
      "subject": "<string>",
      "thread_id": "<string>",
      "starred": true,
      "unread": true,
      "cc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "bcc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "from": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "reply_to": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "labels": [
        "<string>"
      ],
      "in_reply_to": "<string>"
    }
  ],
  "meta": {
    "limit": 123,
    "cursors": {
      "before": "<string>",
      "current": "<string>",
      "next": "<string>"
    }
  }
}

Query Parameters

cursor
string

Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.

raw
boolean

Include raw response. When you want more data from the source

received_after
string
received_before
string
subject
string
from
string
to
string
cc
string
bcc
string
labes
string[]
starred
string
unread
string
direction
string

Response

200 - application/json
data
object[]
required
meta
object
required