Skip to main content
GET
/
routes
/
{routeId}
Get route details
curl --request GET \
  --url https://api.lettermint.co/v1/routes/{routeId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "project_id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "route_type": "transactional",
  "is_default": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "inbound_address": "<string>",
  "inbound_domain": "<string>",
  "inbound_domain_verified_at": "2023-11-07T05:31:56Z",
  "inbound_spam_threshold": 123,
  "project": {
    "id": "<string>",
    "name": "<string>",
    "smtp_enabled": true,
    "token_generated_at": "2023-11-07T05:31:56Z",
    "token_last_used_at": "2023-11-07T05:31:56Z",
    "token_last_used_ip": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "routes": "<array>",
    "routes_count": 123,
    "domains": [
      {
        "id": "<string>",
        "domain": "<string>",
        "status_changed_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "dns_records": [
          {
            "id": "<string>",
            "type": "TXT",
            "hostname": "<string>",
            "fqdn": "<string>",
            "content": "<string>",
            "status": "active",
            "verified_at": "<string>",
            "last_checked_at": "2023-11-07T05:31:56Z"
          }
        ],
        "projects": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      }
    ],
    "domains_count": 123,
    "team_members": [
      {
        "id": "<string>",
        "role": "<string>",
        "joined_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "user": {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "avatar": "<string>"
        }
      }
    ],
    "team_members_count": 123,
    "last_28_days": {
      "messages_transactional": 123,
      "messages_broadcast": 123,
      "messages_inbound": 123,
      "deliverability": 123
    }
  },
  "webhooks_count": 123,
  "suppressed_recipients_count": 123,
  "statistics": {}
}

Authorizations

Authorization
string
header
required

Team API token. Find this in your team settings.

Path Parameters

routeId
string
required

Query Parameters

include
string

Available includes are project, projectCount, projectExists, statistics. You can include multiple options by separating them with a comma.

Response

200 - application/json

RouteData

id
string
required
project_id
string
required
slug
string
required
name
string
required
route_type
enum<string>
required
Available options:
transactional,
broadcast,
inbound
is_default
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
inbound_address
string
inbound_domain
string
inbound_domain_verified_at
string<date-time>
inbound_spam_threshold
number
project
ProjectData · object
webhooks_count
integer
suppressed_recipients_count
integer
statistics
object
  • object
  • RouteStatisticData · object[]