Message

Endpointhttps://api.lettermint.co/v1

List messages for the team

GET

https://api.lettermint.co/v1

/messages

Returns a paginated list of messages with filtering and sorting capabilities.

List messages for the team › query Parameters

sort

string

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.

Default: -created_at

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

filter[type]

string · enum

Enum values:

inbound

outbound

filter[status]

string · enum

Enum values:

pending

queued

suppressed

processed

delivered

opened

clicked

soft_bounced

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

List messages for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List messages for the team › Responses

200

Paginated set of MessageListData

object[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · 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 | null · uri · required

prev_cursor

string | null · required

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

prev_page_url

string | null · uri · required

GET/messages

curl --request GET \
  --url https://api.lettermint.co/v1/messages \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "type": "inbound",
      "status": "pending",
      "from_email": "from_email",
      "from_name": "from_name",
      "subject": "subject",
      "to": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "cc": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "bcc": [
        {
          "email": "email",
          "name": "name"
        }
      ],
      "reply_to": [
        "string"
      ],
      "tag": "tag",
      "created_at": "created_at"
    }
  ],
  "path": "path",
  "per_page": 0,
  "next_cursor": "next_cursor",
  "next_page_url": "https://www.example.com/path/to/resource",
  "prev_cursor": "prev_cursor",
  "prev_page_url": "https://www.example.com/path/to/resource"
}

json

application/json

Get message details

GET

https://api.lettermint.co/v1

/messages/{messageId}

Returns detailed information about a specific message including optional nested resources.

Get message details › path Parameters

messageId

string · required

Get message details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message details › Responses

200

MessageData

id

string · required

type

string · enum · required

Enum values:

inbound

outbound

status

string · enum · required

Enum values:

pending

queued

suppressed

processed

delivered

opened

clicked

soft_bounced

status_changed_at

string | null · date-time · required

tag

string | null · required

from_email

string · required

from_name

string | null · required

reply_to

array | null · required

subject

string | null · required

array | null · required

object | null · required

route_id

string · required

created_at

string · date-time · required

spam_score

number | null

object[]

GET/messages/{messageId}

curl --request GET \
  --url https://api.lettermint.co/v1/messages/:messageId \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "id",
  "type": "inbound",
  "status": "pending",
  "status_changed_at": "2024-08-25T15:00:00Z",
  "tag": "tag",
  "from_email": "from_email",
  "from_name": "from_name",
  "reply_to": [
    "string"
  ],
  "subject": "subject",
  "to": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "cc": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "bcc": [
    {
      "email": "email",
      "name": "name"
    }
  ],
  "attachments": [
    {
      "size": 0,
      "filename": "unknown",
      "content_id": "content_id",
      "content_type": "application/octet-stream"
    }
  ],
  "metadata": {
    "key": "string"
  },
  "spam_score": 0,
  "spam_symbols": [
    {
      "name": "name",
      "score": 0,
      "options": [],
      "description": "description"
    }
  ],
  "route_id": "route_id",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Get message events

GET

https://api.lettermint.co/v1

/messages/{messageId}/events

Returns a paginated list of events for a specific message with sorting capabilities.

Get message events › path Parameters

messageId

string · required

Get message events › query Parameters

sort

string

Available sorts are timestamp, event. 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: -timestamp.

Default: -timestamp

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

Get message events › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message events › Responses

200

Paginated set of MessageEventData

object[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · 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 | null · uri · required

prev_cursor

string | null · required

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

prev_page_url

string | null · uri · required

Get message source

GET

https://api.lettermint.co/v1

/messages/{messageId}/source

Returns the raw EML source of the message.

Get message source › path Parameters

messageId

string · required

Get message source › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message source › Responses

200

string

Get message HTML content

GET

https://api.lettermint.co/v1

/messages/{messageId}/html

Returns the HTML body of the message if available.

Get message HTML content › path Parameters

messageId

string · required

Get message HTML content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message HTML content › Responses

string

Get message plain text content

GET

https://api.lettermint.co/v1

/messages/{messageId}/text

Returns the plain text body of the message if available.

Get message plain text content › path Parameters

messageId

string · required

Get message plain text content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message plain text content › Responses

string

Webhook Suppression

List messages for the team

GET

https://api.lettermint.co/v1

/messages

Returns a paginated list of messages with filtering and sorting capabilities.

List messages for the team › query Parameters

sort

string

Default: -created_at

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

filter[type]

string · enum

Enum values:

inbound

outbound

filter[status]

string · enum

Enum values:

pending

queued

suppressed

processed

delivered

opened

clicked

soft_bounced

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

List messages for the team › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

List messages for the team › Responses

200

Paginated set of MessageListData

object[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · 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 | null · uri · required

prev_cursor

string | null · required

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

prev_page_url

string | null · uri · required

Get message details

GET

https://api.lettermint.co/v1

/messages/{messageId}

Returns detailed information about a specific message including optional nested resources.

Get message details › path Parameters

messageId

string · required

Get message details › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message details › Responses

200

MessageData

id

string · required

type

string · enum · required

Enum values:

inbound

outbound

status

string · enum · required

Enum values:

pending

queued

suppressed

processed

delivered

opened

clicked

soft_bounced

status_changed_at

string | null · date-time · required

tag

string | null · required

from_email

string · required

from_name

string | null · required

reply_to

array | null · required

subject

string | null · required

array | null · required

object | null · required

route_id

string · required

created_at

string · date-time · required

spam_score

number | null

object[]

Get message events

GET

https://api.lettermint.co/v1

/messages/{messageId}/events

Returns a paginated list of events for a specific message with sorting capabilities.

Get message events › path Parameters

messageId

string · required

Get message events › query Parameters

sort

string

Available sorts are timestamp, event. 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: -timestamp.

Default: -timestamp

page[size]

integer

The number of results that will be returned per page.

Default: 30

page[cursor]

string

The cursor to start the pagination from.

Get message events › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message events › Responses

200

Paginated set of MessageEventData

object[] · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · 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 | null · uri · required

prev_cursor

string | null · required

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

prev_page_url

string | null · uri · required

Get message source

GET

https://api.lettermint.co/v1

/messages/{messageId}/source

Returns the raw EML source of the message.

Get message source › path Parameters

messageId

string · required

Get message source › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message source › Responses

200

string

Get message HTML content

GET

https://api.lettermint.co/v1

/messages/{messageId}/html

Returns the HTML body of the message if available.

Get message HTML content › path Parameters

messageId

string · required

Get message HTML content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message HTML content › Responses

string

Get message plain text content

GET

https://api.lettermint.co/v1

/messages/{messageId}/text

Returns the plain text body of the message if available.

Get message plain text content › path Parameters

messageId

string · required

Get message plain text content › Headers

Authorization

string · required

Bearer token. Format: Bearer {team_token}

Get message plain text content › Responses

string