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.

Operation	HTTP Verb	URL Format	Ability Requirements
Read	`GET`	`https://pi.pardot.com/api/v5/objects/emails/<id>?<params>`	Marketing > Emails > Emails > View ability
Query	`GET`	`https://pi.pardot.com/api/v5/objects/emails?<params>`	Marketing > Emails > Emails > View ability

Field	Type	Description
`id`	Integer	ID of the email.
`campaignId`	Integer	ID of the campaign associated with the email.
`clientType`	String	Value 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.
`createdById`	Integer	ID of the user who created this object.
`textMessage`	String	The text content of the email's message. This field isn’t queryable.
`htmlMessage`	String	The HTML content of the email's message. This field isn’t queryable.
`listId`	Integer	Deprecated, always NULL. Reference the List Email object's reciepientLists and suppressionLists fields for all lists associated with the email.
`listEmailId`	Integer	ID of the list email associated with this email.
`name`	String	Name of the email for identification in Pardot.
`sentAt`	DateTime	Time the email was sent.
`subject`	String	The email subject.
`createdBy`	User	User object representing the user who created this object. See documentation for User for fields.
`campaign`	Campaign	Campaign object representing the campaign associated with this object. See documentation for Campaign for fields.
`list`	List	List object representing the list associated with this email. See documentation for List for fields.
`listEmail`	List Email	List 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.

id
sentAt
prospectId

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.

Parameter	Description
`id`	Returns any email where ID is equal to the given integer value.
`idList`	Returns any email where ID is included in the given list of values.
`idGreaterThan`	Returns any email where ID is greater than the specified value, non-inclusive.
`idGreaterThanOrEqualTo`	Returns any email where ID is greater than or equal to the specified value.
`idLessThan`	Returns any email where ID is less than the specified value, non-inclusive.
`idLessThanOrEqualTo`	Returns any email where ID is less than or equal to the specified value.
`prospectId`	Returns any email where Prospect ID is equal to the given integer value.
`prospectIdGreaterThan`	Returns any email where Prospect ID is greater than the specified value, non-inclusive.
`prospectIdGreaterThanOrEqualTo`	Returns any email where Prospect ID is greater than or equal to the specified value.
`prospectIdLessThan`	Returns any email where Prospect ID is less than the specified value, non-inclusive.
`prospectIdLessThanOrEqualTo`	Returns any email where Prospect ID is less than or equal to the specified value.
`listEmailId`	Returns any email where List Email ID is equal to the given integer value.
`listEmailIdGreaterThan`	Returns any email where List Email ID is greater than the specified value, non-inclusive.
`listEmailIdGreaterThanOrEqualTo`	Returns any email where List Email ID is greater than or equal to the specified value.
`listEmailIdLessThan`	Returns any email where List Email ID is less than the specified value, non-inclusive.
`listEmailIdLessThanOrEqualTo`	Returns any email where List Email ID is less than or equal to the specified value.
`sentAt`	Returns any email where SentAt is equal to the given datetime value.
`sentAtAfter`	Returns any email where SentAt is after the given datetime value, non-inclusive.
`sentAtAfterOrEqualTo`	Returns any email where SentAt is after or equal to the given datetime value.
`sentAtBefore`	Returns any email where SentAt is before the given datetime value, non-inclusive.
`sentAtBeforeOrEqualTo`	Returns any email where SentAt is before or equal to the given datetime value.

Example Response