Let the platform do the work
SugarClubContact+1 (877) 842-7276

/Emails/:record GET

Overview

Retrieves an Emails record.

Fields

Name Type Description
<record field> <record field type> Returns the fields for the selected record.
from_collection List The email's sender.
to_collection List The email's recipients found in the TO field.
cc_collection List The email's recipients found in the CC field.
bcc_collection List The email's recipients found in the BCC field.
attachments_collection List The email's attachments.
Request
GET /Emails/a028341c-ba92-9343-55e7-56cf5beda121?fields=name,state,
{"name":"from_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"to_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"cc_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"bcc_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"attachments_collection","fields":["name","filename","file_size",
"file_source","file_mime_type","file_ext","upload_id"]}
Response
{
  "id": "a028341c-ba92-9343-55e7-56cf5beda121",
  "state": "Archived",
  "name": "Re: Discuss Proposal",
  "from_collection": {
    "next_offset": {
      "from": -1
    },
    "records": [{
      "id": "ec113d14-7d27-11e7-a951-3c15c2d582c6",
      "email_address": "tdavis@example.com",
      "email_address_id": "ec05a896-7d27-11e7-a51e-3c15c2d582c6",
      "parent_type": "Leads",
      "parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
      "parent_name": "Tom Davis",
      "_acl": {
        "fields": {}
      },
      "_link": "from",
      "_module": "EmailParticipants"
    }]
  },
  "to_collection": {
    "next_offset": {
      "to": -1
    },
    "records": [{
      "id": "ec0f1278-7d27-11e7-8d1f-3c15c2d582c6",
      "email_address": "ssmith@example.com",
      "email_address_id": "ec0fb516-7d27-11e7-b7ad-3c15c2d582c6",
      "parent_type": "Users",
      "parent_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
      "parent_name": "Sarah Smith",
      "_acl": {
        "fields": {}
      },
      "_link": "to",
      "_module": "EmailParticipants"
    }]
  },
  "cc_collection": {
    "next_offset": {
      "cc": -1
    },
    "records": [{
      "id": "eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6",
      "email_address": "broland@example.com",
      "email_address_id": "ea1cec7e-7d27-11e7-9845-3c15c2d582c6",
      "parent_type": "Users",
      "parent_id": "e087e79a-7d27-11e7-b02c-3c15c2d582c6",
      "parent_name": "Brian Roland",
      "_acl": {
        "fields": {}
      },
      "_link": "cc",
      "_module": "EmailParticipants"
    }, {
      "id": "df5eb204-7d27-11e7-b363-3c15c2d582c6",
      "email_address": "twallace@example.com",
      "email_address_id": "ddf1d9e6-7d27-11e7-bb17-3c15c2d582c6",
      "parent_type": "",
      "parent_id": "",
      "parent_name": "",
      "_acl": {
        "fields": {}
      },
      "_link": "cc",
      "_module": "EmailParticipants"
    }]
  },
  "bcc_collection": {
    "next_offset": {
      "bcc": -1
    },
    "records": []
  },
  "attachments_collection": {
    "next_offset": {
      "attachments": -1
    },
    "records": [{
      "id": "afe9702e-53a3-0efb-6bbe-56c3580885ef",
      "name": "Quote.pdf",
      "filename": "Quote.pdf",
      "upload_id": "",
      "file_mime_type": "application/pdf",
      "file_size": 158589,
      "file_source": "DocumentRevisions",
      "file_ext": "pdf"
      "_acl": {
        "fields": {}
      },
      "_link": "attachments",
      "_module": "Notes"
    }]
  }
  "_acl": {
    "fields": [
    ]
  },
  "_module": "Emails"
}

Change Log

Version Change
v10 Added /Emails/:record GET endpoint.