View Email

Purpose

Use this API to get the details of a single email, including its content, sent from/ received by a record in any of the supported modules.

Endpoints

Request Details

Request URL

{api_domain}/crm/{version}/{module_api_name}/{record_id}/Emails/{message-id}

Supported modules

Leads, Accounts, Contacts, Deals, Quotes, Invoices, Sales Orders, Purchase Orders, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.modules.READ
or
ZohoCRM.modules.{module_name}.READ
and
ZohoCRM.modules.emails.READ

Possible Module Names

leads, accounts, contacts, deals, quotes, invoices, salesorders, purchaseorders, and custom

Parameters

  • user_idinteger, mandatory for viewing shared email id from others.

    The ID of the user whose emails you want to fetch. If you are fetching your own email, this parameter is optional.

Note

When you fetch a specific email, the content key in the response represents the body of the email. Please note that you can fetch the email body only when fetching the specific email, and not all the emails of the record.

Sample request to fetch a specific email of the record

Copiedcurl "https://www.zohoapis.com/v6/Contacts/6821491000000566349/Emails/de735c09069d3022497a4379c012ccd7ee48d916546c214ee36206109afd4222?user_id=6821491000000565001"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • NO_PERMISSIONHTTP 400
    • Permission denied.
      The user does not have permission to view the the records of the module.
      Resolution: Contact administrator for permission to view the record of the module.
    • Your colleague has not provided viewing permissions for the email messages related to this record.
      The user doesn't have permission to view emails of this user under this record.
      Resolution: The user to whom the email belongs to has to share emails via public or custom sharing settings, to the current user who is viewing email.
  • INVALID_DATAHTTP 400

    The related id given seems to be invalid.
    Provided record ID in the request URL is invalid.
    Resolution: Provide a valid record ID.

  • CANNOT_PROCESSHTTP 400
    • This user has been deactivated. The administrator has not initiated a backup.
      Resolution: Contact administrator to initiate email backup.
    • Customer email access in CRM is temporarily unavailable. Sorry for any inconvenience.
      Resolution: Check and resolve error in email integration settings.
    • The configured {0} mailbox may have been changed or deleted and is inaccessible. Please configure another mailbox.
      Resolution: Check and resolve error in email integration settings.
    • Email sync is in progress. You will receive an email notification once the sync is complete.
      User's email sync is in progress via integration.
      Resolution: You can try again after email sync is complete.
    • Sync not yet started
      Email sync yet to be started in user's email integration.
      Resolution: You can try again after email sync completed.
    • Gmail API Authentication failed.
      Resolution: Resolve issues in email integration settings and try again.

Sample Response

Copied{
    "Emails": [
        {
            "attachments": [
                {
                    "size": "24792",
                    "name": "email_templates.png",
                    "id": "72daf06xxx349c51ce66"
                }
            ],
            "subject": "test with attachment",
           "editable": false,
            "mail_format": "html",
            "sent": true,
            "intent": null,
            "content": "<div>\n  <div style=\"font-family:Verdana, arial, Helvetica, sans-serif; font-size:13px\">\n   <div>\n    <div style=\"font-family:undefined\"></div><font face=\"Verdana, Geneva, sans-serif\"><br /></font>hi<span id=\"x_373875665ecw_signature\"></span>\n   </div>\n  </div>\n </div>\n ",
            "sentiment_info": null,
            "sent_time": "2025-05-30T17:40:37+05:30",
            "linked_record": null,
            "thread_id": "a5e9238912f3f668bf9d304b89881492032b5476945134a8f304e35a55e4aff1",
            "emotion": null,
            "reply_to": {
                "user_name": null,
                "email": ""
            },
            "from": {
                "user_name": "Patricia Boyle",
                    "email": "p.boyle@abc.com"
            },
            "to": [
                {
                    "user_name": "John Smith",
                    "email": "smith.j@gmail.com"
                }
            ],
            "feedback_mechanism": false,
            "status": [
                {
                    "first_open": "2025-06-02T14:08:02+05:30",
                    "count": "10",
                    "type": "opened",
                    "last_open": "2025-06-02T14:10:01+05:30"
                }
            ]
        }
    ]
}