v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Communication V2

Get an email by ID

Returns the email identified by the given communication ID. The communication must be an email record, and the caller must have manage permission on the owning lead; otherwise 400 PERMISSION_DENIED is returned (no existence leak).

Webhook follow-up: when an Email webhook is delivered, pass each createdEmail[].timelineId from the payload as the communicationId path parameter to fetch the full record. The legacy createdEmail[].emailId field is kept for backward compatibility but is not interchangeable across communicationType — prefer timelineId.

get/v2.0/communication/email/{communicationId}

Path parameters

communicationIdinteger required

Communication ID of the email.

Headers

Authorizationstring required

Bearer [access_token]

Response

Email retrieved successfully.

idinteger

The ID of the email

leadIdinteger

The lead(Id) associated with the email

directionstring

Outbound or Inbound email

agentIdinteger

The related Agent ID

eventTypestring

Sent, Opened or Bounced event

emailEventTimestring

The event time of the email

emailTypestring

Manual or Auto email

emailSubjectstring

The subject of the email

fromPondboolean

Is the email sent from the lead pond

Example response

{
  "direction": "Outbound",
  "eventType": "Sent",
  "emailType": "Auto"
}