Emails

List sent emails

List sent emails, newest first. Bodies are not included; fetch one with GET /v1/emails/{id}. Requires the email:read scope.

get/v1/emails

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/emails
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size.

pageinteger

1-based page number.

statusstring

Filter by current status, e.g. delivered, bounced, failed, scheduled.

tostring

Exact recipient address.

afterstring

The email id after which to retrieve more emails. Not returned in the list. Use either after or before, not both.

beforestring

The email id before which to retrieve more emails. Not returned in the list. Use either after or before, not both.

Response

A page of emails

objectstring required
pageinteger

Absent when paging with after or before

limitinteger required
totalinteger required

Emails matching the filters; with after or before, only those past that email

has_moreboolean required

Example response

{
  "object": "list",
  "data": [
    {
      "id": "email_abc123",
      "from": "hello@yourapp.com",
      "to": [
        "user@example.com"
      ],
      "subject": "Welcome!",
      "status": "delivered",
      "source": "api",
      "category": "marketing"
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 1204,
  "has_more": true
}

Changes

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