Query

GET https://{{domain}}/api/v5/objects/emails?fields=id,name,subject,userId,campaignId,listId,clientType,sentAt,prospectId,listEmailId,createdById,salesforceCmsId

Request Params

KeyDatatypeRequiredDescription
fieldsstring(required) Email fields to return
deletedbooleanboolean - return deleted records
limitnumberinteger - the number of records to return. This value must be between 1 and 1000, inclusive. Default value is 200.
nextPageTokenstringthe server provided value to retrieve the next page
idnullOptional Integer Filter - filters the result by the id field
idGreaterThannullOptional Integer Filter - filters the result by the id field
idGreaterThanOrEqualTonullOptional Integer Filter - filters the result by the id field
idLessThannullOptional Integer Filter - filters the result by the id field
idLessThanOrEqualTonullOptional Integer Filter - filters the result by the id field
sentAtstringOptional DateTime Filter using sentAt field
sentAtBeforestringOptional DateTime Filter using sentAt field
sentAtBeforeOrEqualTostringOptional DateTime Filter using sentAt field
sentAtAfterstringOptional DateTime Filter using sentAt field
sentAtAfterOrEqualTostringOptional DateTime Filter using sentAt field
prospectIdnullOptional Integer Filter - filters the result by the prospectId field
prospectIdGreaterThannullOptional Integer Filter - filters the result by the prospectId field
prospectIdGreaterThanOrEqualTonullOptional Integer Filter - filters the result by the prospectId field
prospectIdLessThannullOptional Integer Filter - filters the result by the prospectId field
prospectIdLessThanOrEqualTonullOptional Integer Filter - filters the result by the prospectId field
listEmailIdnullOptional Integer Filter - filters the result by the listEmailId field
listEmailIdGreaterThannullOptional Integer Filter - filters the result by the listEmailId field
listEmailIdGreaterThanOrEqualTonullOptional Integer Filter - filters the result by the listEmailId field
listEmailIdLessThannullOptional Integer Filter - filters the result by the listEmailId field
listEmailIdLessThanOrEqualTonullOptional Integer Filter - filters the result by the listEmailId field
orderBystringstring - Order Results By: id, sentAt, prospectId

HEADERS

KeyDatatypeRequiredDescription
Pardot-Business-Unit-Idstring
If-Modified-Sincestring