There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get the details for a marketing email

Last updated May 15, 2023

GET /marketing-emails/v1/emails/:id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Get the details for a specific marketing email.
Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
 Email ID /:id
 Used in the request URL		 The ID of the email that you want to get the details for. 

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/marketing-emails/v1/emails/6866079415 Example response: { "ab": false, "abHoursToWait": 4, "abSampleSizeDefault": null, "abSamplingDefault": null, "abSuccessMetric": null, "abTestPercentage": 50, "abVariation": false, "absoluteUrl": "http://demo-hubapi.hs-sites.com/-temporary-slug-bbaf0e3e-ad74-44fc-b989-90c80b00436f", "allEmailCampaignIds": [], "analyticsPageId": "6866079415", "analyticsPageType": "email", "archived": false, "author": "testapi@hubspot.com", "authorAt": 1545733312064, "authorEmail": "testapi@hubspot.com", "authorName": "Test User", "authorUserId": 215482, "blogRssSettings": null, "campaign": "e5d960a3-8386-4884-a021-ac86d81eabf8", "campaignName": "My First Campaign", "campaignUtm": "my_first_campaign", "canSpamSettingsId": 555565457, "categoryId": 2, "contentTypeCategory": 2, "createPage": false, "created": 1545732674133, "createdById": 215482, "currentState": "AUTOMATED_DRAFT", "currentlyPublished": false, "domain": "", "emailBody": "{% content_attribute \"email_body\" %}{{ default_email_body }}{% end_content_attribute %}", "emailNote": "", "emailTemplateMode": "DESIGN_MANAGER", "emailType": "SINGLE_SEND_API", "emailbodyPlaintext": "", "feedbackEmailCategory": null, "feedbackSurveyId": null, "flexAreas": {}, "freezeDate": 1545733312064, "fromName": "Example Reservations Test", "htmlTitle": "", "id": 6866079415, "isGraymailSuppressionEnabled": false, "isLocalTimezoneSend": false, "isPublished": false, "isRecipientFatigueSuppressionEnabled": false, "lastEditSessionId": 1545732675895, "lastEditUpdateId": 10, "layoutSections": {}, "leadFlowId": null, "liveDomain": "demo-hubapi.hs-sites.com", "mailingListsExcluded": [], "mailingListsIncluded": [], "maxRssEntries": 5, "metaDescription": "", "name": "test mail", "pageExpiryEnabled": false, "pageRedirected": false, "portalId": 62515, "previewKey": "KzVhkqcd", "processingStatus": "", "publishDate": 1545733312064, "publishImmediately": true, "publishedUrl": "", "replyTo": "qa@plexitech.in", "resolvedDomain": "demo-hubapi.hs-sites.com", "rssEmailByText": "By", "rssEmailClickThroughText": "Read more »", "rssEmailCommentText": "Comment »", "rssEmailEntryTemplateEnabled": false, "rssEmailImageMaxWidth": 0, "rssEmailUrl": "", "scrubsSubscriptionLinks": true, "slug": "-temporary-slug-bbaf0e3e-ad74-44fc-b989-90c80b00436f", "smartEmailFields": {}, "state": "AUTOMATED_DRAFT", "styleSettings": null, "subcategory": "single_send_api", "subject": "Test supershuttle reservation email", "subscription": -1, "subscriptionName": "Transactional", "teamPerms": [], "templatePath": "/ss-confirmationemail.html", "transactional": true, "unpublishedAt": 0, "updated": 1545733312064, "updatedById": 215482, "url": "http://demo-hubapi.hs-sites.com/-temporary-slug-bbaf0e3e-ad74-44fc-b989-90c80b00436f", "useRssHeadlineAsSubject": false, "userPerms": [], "vidsExcluded": [], "vidsIncluded": [], "widgets": { "preview_text": { "body": { "value": "" }, "child_css": {}, "css": {}, "id": "preview_text", "label": "Preview Text This will be used as the preview text that displays in some email clients", "name": "preview_text", "order": 0, "smart_type": null, "type": "text" } } }