v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Communication

Email History

Returns email history entries for the given lead. Lead must belong to the caller's team.

get/v1.0/communication/email

Query parameters

leadIdinteger required

ID of the lead whose email history to return.

offsetinteger

Zero-based index of the first entry to return.

limitinteger

Number of entries per page.

currentIdinteger

This parameter is used for page turning. When searching by ID is invoked, the interface would starts from this ID, and retrieve data sequentially. It is recommended to use this parameter as a replacement for offset to turn the page within the limit.

Headers

Authorizationstring required

Bearer [access_token]

Response

Email history entries for the lead.

Example response

{
  "emails": [
    {
      "direction": "Outbound",
      "eventType": "Sent",
      "emailType": "Auto"
    }
  ]
}