HEhellosunset
Emails

List emails

List all emails sent for a case, including delivery status and receipts.

get/cases/{case_id}/emails

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

status'draft' | 'queued' | 'sent' | 'delivered' | 'bounced' | 'failed'
institution_contact_idstring
sort_by'created_at' | 'sent_at'
sort_order'asc' | 'desc'

Sort direction.

Response

List of emails.

Example response

{
  "data": [
    {
      "id": "01K8EM06FJ5T22HRYE78AN7FFF",
      "to_addresses": [
        "estates@chase.com"
      ],
      "cc_addresses": [],
      "from_address": "cases@mail.example.com",
      "subject": "Estate of John J. Johnson - Death Certificate and Account Closure Request",
      "attachments": [
        {
          "file_name": "death_certificate.pdf",
          "file_size_bytes": 245000,
          "mime_type": "application/pdf"
        }
      ],
      "status": "delivered",
      "receipt": {
        "message_id": "msg_01abc123def456",
        "provider": "sendgrid"
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

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