Get all marketing emails for a HubSpot account.
GET {{baseUrl}}/marketing/v3/emails/?createdAt=<dateTime>&createdAfter=<dateTime>&createdBefore=<dateTime>&updatedAt=<dateTime>&updatedAfter=<dateTime>&updatedBefore=<dateTime>&sort=<string>&sort=<string>&after=<string>&limit=<integer>&includeStats=<boolean>&type=OPTIN_EMAIL&isPublished=<boolean>&includedProperties=<string>&includedProperties=<string>&archived=<boolean>&marketingCampaignNames=<boolean>&workflowNames=<boolean>
The results can be filtered, allowing you to find a specific set of emails. See the table below for a full list of filtering options.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
createdAt | string | Only return emails created at exactly the specified time. | |
createdAfter | string | Only return emails created after the specified time. | |
createdBefore | string | Only return emails created before the specified time. | |
updatedAt | string | Only return emails last updated at exactly the specified time. | |
updatedAfter | string | Only return emails last updated after the specified time. | |
updatedBefore | string | Only return emails last updated before the specified time. | |
sort | string | Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. | |
sort | string | Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. | |
after | string | The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results. | |
limit | string | The maximum number of results to return. Default is 100. | |
includeStats | string | Include statistics with emails. | |
type | string | Email types to be filtered by. Multiple types can be included. All emails will be returned if not present. | |
isPublished | string | Filter by published/draft emails. All emails will be returned if not present. | |
includedProperties | string | ||
includedProperties | string | ||
archived | string | Specifies whether to return archived emails. Defaults to false. | |
marketingCampaignNames | string | ||
workflowNames | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"content":{"templatePath":"\u003cstring\u003e","plainTextVersion":"\u003cstring\u003e","widgets":{"ad_d84":{}},"widgetContainers":{"irure_34":{},"sed_9":{},"fugiat2":{},"et_7c0":{},"sunt_acc":{}},"flexAreas":{"magna726":{},"sintebe":{},"tempor_4a":{},"occaecatf15":{}},"styleSettings":{},"smartFields":{"adipisicing_d4":{},"enim1_":{},"culpac6":{}},"themeSettingsValues":{"elit0":{},"occaecatb":{},"anim_e5":{},"cupidatat3":{}}},"from":{"fromName":"\u003cstring\u003e","replyTo":"\u003cstring\u003e","customReplyTo":"\u003cstring\u003e"},"id":"\u003cstring\u003e","name":"\u003cstring\u003e","sendOnPublish":"\u003cboolean\u003e","state":"SCHEDULED_AB","subcategory":"\u003cstring\u003e","subject":"\u003cstring\u003e","to":{"contactLists":{"include":["\u003clong\u003e","\u003clong\u003e"],"exclude":["\u003clong\u003e","\u003clong\u003e"]},"contactIds":{"include":["\u003clong\u003e","\u003clong\u003e"],"exclude":["\u003clong\u003e","\u003clong\u003e"]},"limitSendFrequency":"\u003cboolean\u003e","suppressGraymail":"\u003cboolean\u003e"},"createdById":"\u003cinteger\u003e","type":"MEMBERSHIP_REGISTRATION_EMAIL","activeDomain":"\u003cstring\u003e","archived":"\u003cboolean\u003e","folderId":"\u003clong\u003e","feedbackSurveyId":"\u003cinteger\u003e","stats":{"counters":{"mollit_9d7":"\u003clong\u003e","utd":"\u003clong\u003e","excd7":"\u003clong\u003e"},"deviceBreakdown":{"inb33":{"tempor_b52":"\u003clong\u003e"},"adb7c":{"quis_0":"\u003clong\u003e"}},"qualifierStats":{"dolore47":{"est7":"\u003clong\u003e"}},"ratios":{"dolord55":"\u003cnumber\u003e"}},"testing":{"testId":"\u003clong\u003e","hoursToWait":"\u003cinteger\u003e","abSuccessMetric":"OPENS_BY_DELIVERED","abSampleSizeDefault":"automated_loser_variant","abStatus":"mab_variant","abTestPercentage":"\u003cinteger\u003e","abSamplingDefault":"automated_loser_variant"},"subscriptionDetails":{"subscriptionId":"\u003clong\u003e","preferencesGroupId":"\u003clong\u003e","officeLocationId":"\u003cstring\u003e"},"updatedById":"\u003cinteger\u003e","publishedById":"\u003cinteger\u003e","language":"ff","campaign":"\u003cstring\u003e","webversion":{"slug":"\u003cstring\u003e","domain":"\u003cstring\u003e","title":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","redirectToUrl":"\u003cstring\u003e","redirectToPageId":"\u003clong\u003e","expiresAt":"\u003cdateTime\u003e"},"rssData":{"maxEntries":"\u003cinteger\u003e","timing":{"deseruntc34":{},"Duis_772":{},"nulla_328":{},"idfd2":{}},"url":"\u003cstring\u003e","hubspotBlogId":"\u003clong\u003e","blogEmailType":"\u003cstring\u003e","blogImageMaxWidth":"\u003cinteger\u003e","rssEntryTemplate":"\u003cstring\u003e","useHeadlineAsSubject":"\u003cboolean\u003e","blogLayout":"\u003cstring\u003e"},"isTransactional":"\u003cboolean\u003e","isPublished":"\u003cboolean\u003e","publishDate":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","createdAt":"\u003cdateTime\u003e","deletedAt":"\u003cdateTime\u003e","publishedAt":"\u003cdateTime\u003e"},{"content":{"templatePath":"\u003cstring\u003e","plainTextVersion":"\u003cstring\u003e","widgets":{"dolore6":{},"veniamcf":{}},"widgetContainers":{"cillumb3":{},"consequat_e":{}},"flexAreas":{"pariaturcd6":{},"sitf":{}},"styleSettings":{},"smartFields":{"tempor_8e3":{}},"themeSettingsValues":{"esse_c47":{},"dolore_0f":{}}},"from":{"fromName":"\u003cstring\u003e","replyTo":"\u003cstring\u003e","customReplyTo":"\u003cstring\u003e"},"id":"\u003cstring\u003e","name":"\u003cstring\u003e","sendOnPublish":"\u003cboolean\u003e","state":"AUTOMATED_DRAFT_ABVARIANT","subcategory":"\u003cstring\u003e","subject":"\u003cstring\u003e","to":{"contactLists":{"include":["\u003clong\u003e","\u003clong\u003e"],"exclude":["\u003clong\u003e","\u003clong\u003e"]},"contactIds":{"include":["\u003clong\u003e","\u003clong\u003e"],"exclude":["\u003clong\u003e","\u003clong\u003e"]},"limitSendFrequency":"\u003cboolean\u003e","suppressGraymail":"\u003cboolean\u003e"},"createdById":"\u003cinteger\u003e","type":"OPTIN_EMAIL","activeDomain":"\u003cstring\u003e","archived":"\u003cboolean\u003e","folderId":"\u003clong\u003e","feedbackSurveyId":"\u003cinteger\u003e","stats":{"counters":{"magna8":"\u003clong\u003e"},"deviceBreakdown":{"nona0d":{"culpa6f2":"\u003clong\u003e"},"ea_11":{"velit8b":"\u003clong\u003e","aute___":"\u003clong\u003e"}},"qualifierStats":{"et634":{"sedec":"\u003clong\u003e"}},"ratios":{"dolor_0a":"\u003cnumber\u003e","amet_a2":"\u003cnumber\u003e","enime":"\u003cnumber\u003e"}},"testing":{"testId":"\u003clong\u003e","hoursToWait":"\u003cinteger\u003e","abSuccessMetric":"CLICKS_BY_DELIVERED","abSampleSizeDefault":"mab_master","abStatus":"automated_variant","abTestPercentage":"\u003cinteger\u003e","abSamplingDefault":"loser_variant"},"subscriptionDetails":{"subscriptionId":"\u003clong\u003e","preferencesGroupId":"\u003clong\u003e","officeLocationId":"\u003cstring\u003e"},"updatedById":"\u003cinteger\u003e","publishedById":"\u003cinteger\u003e","language":"sq-mk","campaign":"\u003cstring\u003e","webversion":{"slug":"\u003cstring\u003e","domain":"\u003cstring\u003e","title":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","redirectToUrl":"\u003cstring\u003e","redirectToPageId":"\u003clong\u003e","expiresAt":"\u003cdateTime\u003e"},"rssData":{"maxEntries":"\u003cinteger\u003e","timing":{"dolore_e_":{}},"url":"\u003cstring\u003e","hubspotBlogId":"\u003clong\u003e","blogEmailType":"\u003cstring\u003e","blogImageMaxWidth":"\u003cinteger\u003e","rssEntryTemplate":"\u003cstring\u003e","useHeadlineAsSubject":"\u003cboolean\u003e","blogLayout":"\u003cstring\u003e"},"isTransactional":"\u003cboolean\u003e","isPublished":"\u003cboolean\u003e","publishDate":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","createdAt":"\u003cdateTime\u003e","deletedAt":"\u003cdateTime\u003e","publishedAt":"\u003cdateTime\u003e"}],"total":"\u003cinteger\u003e","paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}