List Emails

{
  "hasMore": true,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "hostId": "string",
      "subject": "string",
      "sent": true,
      "date_sent": "2019-08-24T14:15:22Z",
      "reply_to_email": "string",
      "automatic": true,
      "display_name": "string",
      "page_id": "string",
      "data_version": 0,
      "sync_event_recipients": true,
      "attachments": [
        {
          "name": "string",
          "size": 0,
          "url": "string",
          "type": "string",
          "uploading": true,
          "uploadError": "string",
          "storagePath": "string"
        }
      ],
      "sparkpost_metrics": {
        "count_sent": -9007199254740991,
        "count_delivered": -9007199254740991,
        "count_opens": -9007199254740991,
        "count_clicks": -9007199254740991,
        "count_bounce": -9007199254740991,
        "count_unsubscribe": -9007199254740991,
        "bounce_rate": "string",
        "open_rate": "string",
        "click_rate": "string",
        "revenue_generated": -9007199254740991,
        "fetched_at": 0
      },
      "activity_synced_at": 0,
      "createdAt": 0,
      "updatedAt": 0,
      "recipient_count": -9007199254740991
    }
  ]
}

export interface Response {
  /**
   * If true, there are more pages of results available.
   */
  hasMore: boolean;
  pageNumber: number;
  pageSize: number;
  data: {
    id?: string;
    /**
     * ID of the host workspace that owns this email.
     */
    hostId?: string;
    /**
     * The email subject.
     */
    subject?: string;
    /**
     * False for drafts; true once sent or scheduled.
     */
    sent?: boolean;
    /**
     * When the email was sent or is scheduled to send, as an ISO string. Undefined for drafts.
     */
    date_sent?: string;
    /**
     * Reply-to address. Falls back to a system address when unset.
     */
    reply_to_email?: string;
    /**
     * Whether this email was generated by the automatic event-broadcast flow.
     */
    automatic?: boolean;
    /**
     * Sender label shown on the "From" line.
     */
    display_name?: string;
    /**
     * ID of the Page this email renders.
     */
    page_id?: string;
    /**
     * Which content format this email uses. Assume `content_blocks` (0) when absent.
     */
    data_version?: 0 | 1 | 2;
    /**
     * If true, scheduled sends re-sync recipients from the linked events at send time.
     */
    sync_event_recipients?: boolean;
    /**
     * File attachments included with the email.
     */
    attachments?: {
      /**
       * The original filename of the attachment.
       */
      name: string;
      /**
       * File size in bytes.
       */
      size: number;
      /**
       * Publicly fetchable URL.
       */
      url: string;
      /**
       * MIME type, e.g. `application/pdf`, `image/jpeg`.
       */
      type: string;
      uploading?: boolean;
      uploadError?: string;
      storagePath?: string;
    }[];
    /**
     * Delivery metrics and referral revenue for a sent email.
     */
    sparkpost_metrics?: {
      /**
       * Total messages sent.
       */
      count_sent: number;
      /**
       * Messages delivered to a recipient inbox (no bounce).
       */
      count_delivered: number;
      /**
       * Unique opens, counted by distinct recipient.
       */
      count_opens: number;
      /**
       * Unique clicks, counted by distinct recipient.
       */
      count_clicks: number;
      /**
       * Bounced messages (hard and soft).
       */
      count_bounce: number;
      /**
       * Recipients who unsubscribed.
       */
      count_unsubscribe: number;
      /**
       * Pre-formatted percentage, e.g. "2.3%"
       */
      bounce_rate: string;
      /**
       * Pre-formatted percentage, e.g. "10.0%"
       */
      open_rate: string;
      /**
       * Pre-formatted percentage, e.g. "1.5%"
       */
      click_rate: string;
      /**
       * Revenue attributed via referral tracking, minor units (cents)
       */
      revenue_generated?: number;
      /**
       * Epoch ms when these metrics were last fetched from Sparkpost
       */
      fetched_at?: number;
    };
    /**
     * Epoch ms when the activity feed was last synced from Sparkpost + orders.
     */
    activity_synced_at?: number;
    /**
     * Creation time, in epoch milliseconds.
     */
    createdAt?: number;
    /**
     * Last-updated time, in epoch milliseconds.
     */
    updatedAt?: number;
    /**
     * Number of recipients for this email.
     */
    recipient_count?: number;
  }[];
}