Skip to main content
GET
/
messages
List messages for the team
curl --request GET \
  --url https://api.lettermint.co/v1/messages \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "inbound",
      "status": "pending",
      "from_email": "<string>",
      "from_name": "<string>",
      "subject": "<string>",
      "to": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "cc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "bcc": [
        {
          "email": "<string>",
          "name": "<string>"
        }
      ],
      "reply_to": [
        "<string>"
      ],
      "tag": "<string>",
      "created_at": "<string>"
    }
  ],
  "path": "<string>",
  "per_page": 123,
  "next_cursor": "<string>",
  "next_page_url": "<string>",
  "prev_cursor": "<string>",
  "prev_page_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
sort
string
default:-created_at

Available sorts are type, status, from_email, subject, created_at, status_changed_at. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -type.

​
page[size]
integer
default:30

The number of results that will be returned per page.

​
page[cursor]
string

The cursor to start the pagination from.

​
filter[type]
enum<string>
Available options:
inbound,
outbound
​
filter[status]
enum<string>
Available options:
pending,
queued,
suppressed,
processed,
delivered,
soft_bounced,
hard_bounced,
spam_complaint,
failed,
blocked,
policy_rejected,
unsubscribed
​
filter[route_id]
string

Filter by route ID

​
filter[domain_id]
string

Filter by domain ID

​
filter[tag]
string

Filter by tag name

​
filter[from_email]
string

Search by sender email (partial match)

​
filter[subject]
string

Search by subject (partial match)

​
filter[from_date]
string

Filter messages created after this date

​
filter[to_date]
string

Filter messages created before this date

Response

200 - application/json

Paginated set of MessageListData

​
data
MessageListData · object[]
required
​
path
string | null
required

Base path for paginator generated URLs.

​
per_page
integer
required

Number of items shown per page.

​
next_cursor
string | null
required

The "cursor" that points to the next set of items.

​
next_page_url
string<uri> | null
required
​
prev_cursor
string | null
required

The "cursor" that points to the previous set of items.

​
prev_page_url
string<uri> | null
required