Emails

List Scheduled Emails

List the scheduled emails of your team, newest first. Requires the emails:read scope.

This endpoint is new: listing was previously impossible because SparkPost's transmission list endpoint returns 404. Lettr now holds scheduled emails in its own store, so they can be listed, read back and cancelled at any point before they are injected.

A sandbox key only sees the emails it scheduled itself.

get/emails/scheduled

Request

  • Base URL: https://app.lettr.com/api
  • URL: https://app.lettr.com/api/emails/scheduled
  • Auth: HTTP bearer

Query parameters

status'scheduled' | 'sending' | 'sent' | 'cancelled' | 'failed'

Filter by scheduled email state

per_pageinteger

Number of results per page (1-100). Defaults to 25.

pageinteger

Page number. Defaults to 1.

Response

Scheduled emails retrieved successfully.

messagestring required

Example response

{
  "data": {
    "scheduled_emails": [
      {
        "request_id": "sch_01JQZ3N2K8XW9V6M4TBRC7YHDE",
        "transmission_id": "12345678901234567890",
        "state": "scheduled",
        "scheduled_at": "2024-01-16T10:00:00Z",
        "from": "sender@example.com",
        "from_name": "Sender Name",
        "subject": "Scheduled Newsletter",
        "recipients": [
          "recipient@example.com"
        ],
        "num_recipients": 1,
        "accepted": 1,
        "tag": "welcome-series-2024",
        "events": [
          {
            "event_id": "7609871845907017144",
            "timestamp": "2024-01-15T10:31:00.000Z",
            "request_id": "7610639000055488914",
            "rcpt_to": "recipient@example.com",
            "raw_rcpt_to": "recipient@example.com",
            "recipient_domain": "example.com",
            "mailbox_provider": "Gmail",
            "mailbox_provider_region": "Global",
            "message_id": "699715cd9e6961853a97",
            "subject": "Welcome to Lettr",
            "friendly_from": "sender@example.com",
            "sending_domain": "example.com",
            "sending_ip": "168.203.51.91",
            "msg_size": 30823,
            "injection_time": "2024-01-15T10:30:00.000Z",
            "campaign_id": "welcome-series",
            "template_id": "template_7610639000055488914",
            "template_version": "0",
            "ip_pool": "default",
            "msg_from": "msprvs1=abc123=bounces@sparkpostmail1.com",
            "delv_method": "esmtp",
            "recv_method": "rest",
            "routing_domain": "gmail.com"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.