Skip to main content
GET
/
marketing-emails
/
v1
/
emails
Get all marketing emails
curl --request GET \
  --url https://api.hubapi.com/marketing-emails/v1/emails
{
  "limit": 123,
  "objects": [
    {
      "ab": true,
      "abHoursToWait": 123,
      "abTestPercentage": 123,
      "abVariation": true,
      "absoluteUrl": "<string>",
      "allEmailCampaignIds": [
        123
      ],
      "analyticsPageId": "<string>",
      "analyticsPageType": "<string>",
      "archived": true,
      "author": "<string>",
      "authorAt": 123,
      "authorEmail": "<string>",
      "authorName": "<string>",
      "authorUserId": 123,
      "campaign": "<string>",
      "campaignName": "<string>",
      "campaignUtm": "<string>",
      "canSpamSettingsId": 123,
      "categoryId": 123,
      "contentTypeCategory": 123,
      "created": 123,
      "createdById": 123,
      "currentState": "<string>",
      "currentlyPublished": true,
      "domain": "<string>",
      "emailBody": "<string>",
      "emailNote": "<string>",
      "emailTemplateMode": "<string>",
      "emailType": "<string>",
      "emailbodyPlaintext": "<string>",
      "freezeDate": 123,
      "fromName": "<string>",
      "htmlTitle": "<string>",
      "id": 123,
      "isGraymailSuppressionEnabled": true,
      "isLocalTimezoneeSend": true,
      "isPublished": true,
      "isRecipientFatigueSuppressionEnabled": true,
      "lastEditSessionId": 123,
      "lastEditUpdateId": 123,
      "layoutSections": {},
      "leadFlowId": 123,
      "liveDomain": "<string>",
      "mailingListsExcluded": [
        123
      ],
      "mailingListsIncluded": [
        123
      ],
      "maxRssEntries": 123,
      "metaDescription": "<string>",
      "name": "<string>",
      "pageExpiryEnabled": true,
      "pageRedirected": true,
      "portalId": 123,
      "previewKey": "<string>",
      "processingStatus": "<string>",
      "publishDate": 123,
      "publishImmediately": true,
      "publishedUrl": "<string>",
      "replyTo": "<string>",
      "resolvedDomain": "<string>",
      "rssEmailByText": "<string>",
      "rssEmailClickThroughText": "<string>",
      "rssEmailCommentText": "<string>",
      "rssEmailEntryTemplateEnabled": true,
      "rssEmailImageMaxWidth": 123,
      "rssEmailUrl": "<string>",
      "slug": "<string>",
      "smartEmailFields": {},
      "state": "<string>",
      "styleSettings": {},
      "subcategory": "<string>",
      "subject": "<string>",
      "subscription": 123,
      "subscriptionName": "<string>",
      "teamPerms": [
        "<string>"
      ],
      "templatePath": "<string>",
      "transactional": true,
      "unpublishedAt": 123,
      "updated": 123,
      "updatedById": 123,
      "url": "<string>",
      "useRssHeadlineAsSubject": true,
      "userPerms": [
        "<string>"
      ],
      "vidsExcluded": [
        123
      ],
      "vidsIncluded": [
        123
      ],
      "widgets": {}
    }
  ],
  "offset": 123,
  "total": 123,
  "totalCount": 123
}

Required Scopes

This API requires one of the following scopes:
  • content

Query Parameters

limit
integer
default:10

The number of records to return in the response. Defaults to 10. Note: A hard limit of 300 records returned.

Required range: x <= 300
offset
integer

Used to get the next page of results. Use the limit of the previous request as the offset to get the next set of results.

orderBy
string

Return the emails ordered by a particular field value. Use a negative value to sort in descending order (e.g. orderBy=-created).

Response

List of marketing emails

limit
integer

The number of records returned

objects
object[]
offset
integer

The offset for pagination

total
integer

Total number of emails

totalCount
integer

Total count of emails