Query
GET https://{{domain}}/api/v5/objects/emails?fields=id,name,subject,userId,campaignId,listId,clientType,sentAt,prospectId,listEmailId,createdById,salesforceCmsId
Request Params
Key | Datatype | Required | Description |
---|
fields | string | | (required) Email fields to return |
deleted | boolean | | boolean - return deleted records |
limit | number | | integer - the number of records to return. This value must be between 1 and 1000, inclusive. Default value is 200. |
nextPageToken | string | | the server provided value to retrieve the next page |
id | null | | Optional Integer Filter - filters the result by the id field |
idGreaterThan | null | | Optional Integer Filter - filters the result by the id field |
idGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the id field |
idLessThan | null | | Optional Integer Filter - filters the result by the id field |
idLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the id field |
sentAt | string | | Optional DateTime Filter using sentAt field |
sentAtBefore | string | | Optional DateTime Filter using sentAt field |
sentAtBeforeOrEqualTo | string | | Optional DateTime Filter using sentAt field |
sentAtAfter | string | | Optional DateTime Filter using sentAt field |
sentAtAfterOrEqualTo | string | | Optional DateTime Filter using sentAt field |
prospectId | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdGreaterThan | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdLessThan | null | | Optional Integer Filter - filters the result by the prospectId field |
prospectIdLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the prospectId field |
listEmailId | null | | Optional Integer Filter - filters the result by the listEmailId field |
listEmailIdGreaterThan | null | | Optional Integer Filter - filters the result by the listEmailId field |
listEmailIdGreaterThanOrEqualTo | null | | Optional Integer Filter - filters the result by the listEmailId field |
listEmailIdLessThan | null | | Optional Integer Filter - filters the result by the listEmailId field |
listEmailIdLessThanOrEqualTo | null | | Optional Integer Filter - filters the result by the listEmailId field |
orderBy | string | | string - Order Results By: id, sentAt, prospectId |
Key | Datatype | Required | Description |
---|
Pardot-Business-Unit-Id | string | | |
If-Modified-Since | string | | |