Purpose
This API fetches the email logs based on the given search criteria(s).
Request URL
Method : GET
https://api.zeptomail.com/v1.1/email
OAuth scope
The steps to generate and use OAuth token can be found here.
scope=Zeptomail.email.ALL
or
scope=Zeptomail.email.READ
ALL -This gives full CRUD (Create, Read, Update and Delete) access to all email logs APIs.
READ - This allows access to perform the READ operation alone.
Path parameter
https://api.zeptomail.com/v1.1/email/? <search criteria and its corresponding value>
You can search for multiple criteria by separating them with the '&' symbol. For example: https://api.zeptomail.com/v1.1/email/? <search criteria 1& search criteria 2>
Request body
You can use the desired criteria from the list below, in the API request. The API response will contain the search value as well as the listed parameters.
- mailagent_key String
- Agent key obtained from the SMTP/API section.
- To obtain: 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 AM/PM. Example: 19/02/2025, 01:00 AM.
- date_to String
- Date till which the values are to be fetched
- Format: DD/MM/YYYY, hh:mm AM/PM. Example: 19/02/2025, 01:00 AM.
- 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 the rest.
Sample request
curl "https://api.zeptomail.in/v1.1/email/?{search-criteria}" -X GET -H "Authorization : Zoho-oauthtoken ***"\ -H "Content-Type : application/json" \
Sample response
{ "metadata": { "offset": 0, "count": 3, }, "data": { "logs": [ { "email_tracking_details": {}, "email_delivery_details": {}, "email_info": { "email_reference": "ea36f19a.737a00c139129ee5.m1.e2278fa0-ecc5-11ee-90a5-525400256d50.18e83943d9a@zylkertech.in", "mail_type": "Welcome email", "subject": "Welcome to the service!", "bounce_address": "bounce@zylkertech.in", "from": { "address": "one@zylkertech.in" }, "message_id": "