Fetch specific email details

Purpose

This API fetches a specific email log with the help of an email reference id.

Request URL

Method : GET

https://api.zeptomail.com /v1.1/email/email-reference/{email-reference}

OAuth scope

The steps to generate and use OAuth token can be found here.

scope=Zeptomail.email.READ

Path parameter

Parameter nameTypeDescription
email-referenceString Message id or Request id of the email

Response parameters

  • agent_key String
    • Agent key obtained from the SMTP/API section.
    • To generate:  Agent > SMTP/API section > API > Copy Agent alias.
  • request_id String
    • Request id of the email.
  • date_from String
    • Date from which the values are to be fetched.
    • Format: DD/MM/YYYY; hh/mm
  • date_to String
    • Date till which the values are to be fetched
    • Format: DD/MM/YYYY; hh/mm
  • from String
    • The FROM address whose details are to be obtained.
  • to String
    • Recipient email address.
  • cc String
    • The CC'd recipient email address.
  • bcc String
    • The BCC'd recipient email address.
  • recipient String
    • The FROM address whose details are to be obtained.
  • offset Int 
    • Number of records to skip from the top.
  • limit  Int 
    • Number of records to be displayed.
  • subject String
    • Email subject
  • client_reference String
    • Client reference id of the email.
  • is_hb Boolean
    • Filters out all the hard bounced emails and displays the rest.
  • is_sb Boolean
    • Filters out all the soft bounced emails and displays the rest.
  • is_mailfailure Boolean
    • Filters out all the processed failed emails and displays the rest. 
  • is_delivered Boolean
    • Filters out all the delivered emails and displays the rest.

Sample Request

Copiedcurl "https://api.zeptomail.in/v1.1/email/{email-reference}"
-X GET
-H "Authorization : Zoho-oauthtoken ***"\
-H "Content-Type : application/json" \

Sample Response

Copied     {
       "data": {
         "email_tracking_details": {
           "email_open": {
             "details": [
               {
                 "time": "2024-03-14T03:48:29-07:00",
                 "first_event_time": "2024-03-14T03:48:28-07:00",
                 "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0"
               }
             ],
             "event_count": 1
           },
           "email_link_click": {
             "details": [
               {
                 "time": "2024-03-14T03:48:29-07:00",
                 "first_event_time": "2024-03-14T03:48:28-07:00",
                 "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0"
               }
             ],
             "event_count": 1
           }
         },
         "email_delivery_details": {
           "hardbounce": [
             {
               "reason": "mail.com (mxgmxus009) Nemesis ESMTP Service not available No SMTP service IP address is block listed. For explanation visit https://postmaster.mail.com/en/case?c=r0302&i=ip&v=182.74.243.58&r=1Mfqj9-1r3ZFV2uqn-00iCdq Remote-MTA: dns; mx01.mail.com",
               "recipient": "t1@mail.com",
               "time": "2024-02-14T13:21:24+05:30",
               "category": "Policy failure"
             }
           ]
         },
         "email_info": {
           "email_reference": "ea36f19a.737a00c139129ee5.m1.aa4f6f50-cb0d-11ee-a6fa-525400d08b0c.18da69822c5@zylkertech.in",
           "mail_type": "send-mail",
           "subject": "Account Confirmation",
           "bounce_address": "bounce@zylkertech.in",
           "from": {
             "address": "alert@zylkertech.in",
             "name": "Rebecca"
           },
           "message_id": "<ea36f19a.737a00c139129ee5.m1.aa4f6f50-cb0d-11ee-a6fa-525400d08b0c.18da69822c5@zylkertech.in>",
           "to": [
             {
               "address": "Jon@zylker.com",
               "name": "Jon"
             },
             {
               "address": "george@zylker.com",
               "name": "George"
             }
           ],
           "processed_time": "2024-02-14T13:20:04+05:30",
           "agent_key": "ea36f19a.737a00c139129ee5.a3a6bf2fbcae297",
           "status": "processed"
         },
         "request_id": "ea36f19a.737a00c139129ee5.m1.aa4f6f50-cb0d-11ee-a6fa-525400d08b0c.18da69822c5"
       },
       "status": "success"
     }