Email Object

Use email resources to send emails to prospects, and to learn how prospects responded to the emails. Learn more about email in Salesforce Help.

The API to access the Email object follows the conventions described in Version 5 Overview.

OperationHTTP VerbURL FormatAbility Requirements
ReadGEThttps://pi.pardot.com/api/v5/objects/emails/<id>?<params>Marketing > Emails > Emails > View ability
QueryGEThttps://pi.pardot.com/api/v5/objects/emails?<params>Marketing > Emails > Emails > View ability

Read-Only Fields

FieldTypeDescription
idIntegerID of the email.
campaignIdIntegerID of the campaign associated with the email.
clientTypeStringValue is "Builder" if the email was sent via the Lightning Email Builder. Value is "Web" if it was sent via the legacy Pardot email builder.
createdByIdIntID of the user who created this object.
textMessageStringThe text content of the email's message. This field isn’t queryable.
htmlMessageStringThe HTML content of the email's message. This field isn’t queryable.
listIdIntegerID of the list associated with this email.
listEmailIdIntegerID of the list email associated with this email.
nameStringName of the email for identification in Pardot.
sentAtDateTimeTime the email was sent.
subjectStringThe email subject.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
campaignCampaignCampaign object representing the campaign associated with this object. See documentation for Campaign for fields.
listListList object representing the list associated with this email. See documentation for List for fields.
listEmailList EmailList object representing the list email associated with this email. See documentation for List Email for fields.

Retrieve a single list email following the conventions described in the Version 5 Overview.

Example Request

Example Response

Retrieve a collection of emails following the conventions described in Version 5 Overview.

Sortable Fields

  • id
  • sentAt
  • prospectId

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

ParameterDescription
idReturns any emails where ID is equal to the given integer value.
idGreaterThanReturns any emails where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any emails where ID is greater than or equal to the specified value.
idLessThanReturns any emails where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any emails where ID is less than or equal to the specified value.
prospectIdReturns any emails where Prospect ID is equal to the given integer value.
prospectIdGreaterThanReturns any emails where Prospect ID is greater than the specified value, non-inclusive.
prospectIdGreaterThanOrEqualToReturns any emails where Prospect ID is greater than or equal to the specified value.
prospectIdLessThanReturns any emails where Prospect ID is less than the specified value, non-inclusive.
prospectIdLessThanOrEqualToReturns any emails where Prospect ID is less than or equal to the specified value.
listEmailIdReturns any emails where List Email ID is equal to the given integer value.
listEmailIdGreaterThanReturns any emails where List Email ID is greater than the specified value, non-inclusive.
listEmailIdGreaterThanOrEqualToReturns any emails where List Email ID is greater than or equal to the specified value.
listEmailIdLessThanReturns any emails where List Email ID is less than the specified value, non-inclusive.
listEmailIdLessThanOrEqualToReturns any emails where List Email ID is less than or equal to the specified value.
sentAtReturns any emails where SentAt is equal to the given datetime value.
sentAtAfterReturns any emails where SentAt is after the given datetime value, non-inclusive.
sentAtAfterOrEqualToReturns any emails where SentAt is after or equal to the given datetime value.
sentAtBeforeReturns any emails where SentAt is before the given datetime value, non-inclusive.
sentAtBeforeOrEqualToReturns any emails where SentAt is before or equal to the given datetime value.

Example Response