email logs

Get All Email Logs

Retrieve a list of outgoing email logs from your CPaaS account. Supports filtering by date range, recipient, subject, and more. Logs are retained for 60 days.

get/email

Request

  • Base URL
    https://cpaas.zoho.com/v1.1
  • Auth
    • OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.email.READ
    • or OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.email.ALL

Query parameters

mailagent_keystring
Example:123456abcd78

Filter logs by Mail Agent key.

request_idstring
Example:req-xxxx

Filter by a specific request ID.

date_fromstring
Example:01/06/2025, 12:00 AM

Filter logs from this date and time (format: dd/MM/yyyy, hh:mm a).

date_tostring
Example:30/06/2025, 11:59 PM

Filter logs up to this date and time (format: dd/MM/yyyy, hh:mm a).

fromstring
Example:accounts@info.zylker.com

Filter by sender email address.

tostring
Example:rudra.d@zylker.com

Filter by recipient email address.

ccstring
Example:manager@zylker.com

Filter by CC email address.

bccstring
Example:archive@zylker.com

Filter by BCC email address.

recipientstring
Example:user@example.com

Filter by any recipient (To, CC, or BCC).

offsetinteger

Starting position for pagination.

limitinteger
Example:25

Number of logs to return per request.

subjectstring
Example:Account Confirmation

Filter by email subject.

client_referencestring
Example:order-12345

Filter by custom client reference.

is_hbboolean

Filter for hard bounced emails.

is_sbboolean

Filter for soft bounced emails.

is_mailfailureboolean

Filter for failed emails.

is_deliveredboolean

Filter for delivered emails.

Response

List of email logs.

statusstring

Example response

{
  "data": [
    {
      "email_reference": "ref-xxxx-xxxx",
      "sent_time": "2025-06-04T08:19:00Z",
      "subject": "Account Confirmation",
      "from": "accounts@info.zylker.com",
      "to": "rudra.d@zylker.com",
      "request_id": "req-xxxx",
      "mailagent_key": "123456abcd78",
      "status": "delivered"
    }
  ],
  "status": "success"
}

Changes

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