Get a blog post by ID

Last updated June 17, 2020

GET /content/api/v2/blog-posts/:blog_post_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get a specific blog post by ID

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.
blog_post_id Used in the request URL Unique identifier for a particular blog

Example Usage and Result

Hit this URL with a HTTP method of GET  https://api.hubapi.com/content/api/v2/blog-posts/5574003719?hapikey=demo

JSON Fields returned in the response

Parameter name Type Description
archived bool If True, the post will not show up in your dashboard, although the post will still be live
blog_author_id long The integer id of the blog author, look up via the blog authors end point /content/api/v2/blog-authors
campaign string The guid of the marketing campaign this post is associated with
campaign_name string The name of the marketing campaign this post is associated with
content_group_id long The id of the blog that this post belongs to. Get the id by looking at the blog API endpoint /content/api/v2/blogs
created long When the post was first created, in milliseconds since the epoch
deleted_at long When the post was deleted, in milliseconds since the epoch. Zero if the blog post was never deleted. Use a DELETE request to delete the post, do not set this directly.
footer_html string Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page
head_html string Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page
is_draft string True if the post is still a draft, invisible to the public. Gets changed when the /publish-action API endpoint is called
keywords list A JSON list of keywords and their GUIDs. This list contains key value pairs of "keyword" and "keyword_guid". For example:
  • "keyword" : "sandwiches",
  • "keyword_guid" : "ee7c2292-7a2f-4f0f-81fb-ad0bd9ca4fcb"
The GUID is available from the Keywords API. This list adds keywords to the Optimization tab in HubSpot.
meta_description string A description that goes in <meta> tag on the page
name string The internal name of the blog post
post_body string The HTML of the main post body
post_summary string The summary of the blog post that will appear on the main listing page
publish_date long The date the blog post is to be published at in milliseconds since the unix epoch.
publish_immediately string Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting
slug string The path of the URL on which the post will live. Changing this will change the URL.
topic_ids list A json list of topic ids from the topics API ( /content/api/v2/topics )
updated long When the post was last updated, in milliseconds since the epoch
url string The full URL with domain and scheme to the blog post. Will return a 404 if the post is not yet published.
widgets string A data structure containing the data for all the modules for this post. This will only be populated if the blog template has editable widgets defined.

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: api.hubapi.com/content/api/v2/blog-posts/6860971618?hapikey=demo Example Response: { "ab": false, "ab_variation": false, "absolute_url": "http://demo-hubapi.hs-sites.com/tb-es/test-blog", "analytics_page_id": "6860971618", "analytics_page_type": "blog-post", "archived": false, "are_comments_allowed": true, "attached_stylesheets": [], "author": "testapi@hubspot.com", "author_at": 1550838546938, "author_email": "testapi@hubspot.com", "author_name": "Krishna Tester", "author_user_id": 215482, "author_username": "testapi@hubspot.com", "blog_author": { "avatar": "", "bio": "This is a test bio for a test author", "created": 1416431792000, "deleted_at": 0, "display_name": "Test 2", "email": "testapi@hubspot.com", "facebook": "", "full_name": "Test 2", "google_plus": "", "gravatar_url": "https://app.hubspot.com/settings/avatar/bb23f3ae97b9698d130c02d2841e86a4", "has_social_profiles": true, "id": 2112866420, "linkedin": "", "portal_id": 62515, "slug": "test-2", "twitter": "https://twitter.com/hubspotsupport", "twitter_username": "@hubspotsupport", "updated": 1416501139000, "website": "" }, "blog_author_id": 2112866420, "blog_post_author": { "avatar": "", "bio": "This is a test bio for a test author", "created": 1416431792000, "deleted_at": 0, "display_name": "Test 2", "email": "testapi@hubspot.com", "facebook": "", "full_name": "Test 2", "google_plus": "", "gravatar_url": "https://app.hubspot.com/settings/avatar/bb23f3ae97b9698d130c02d2841e86a4", "has_social_profiles": true, "id": 2112866420, "linkedin": "", "portal_id": 62515, "slug": "test-2", "twitter": "https://twitter.com/hubspotsupport", "twitter_username": "@hubspotsupport", "updated": 1416501139000, "website": "" }, "blog_publish_to_social_media_task": "DONE", "blueprint_type_id": 0, "campaign": "f5ee2d36-c5d6-4bb2-a1db-167b29af2973", "campaign_name": "campaign", "campaign_utm": "campaign", "category": 3, "category_id": 3, "comment_count": 0, "composition_id": 442078, "content_group": 6513512292, "content_group_id": 6513512292, "content_type_category": 3, "content_type_category_id": 3, "created": 1545650998759, "created_by_id": 215482, "created_time": 1545650998759, "css": {}, "css_text": "", "ctas": null, "current_state": "PUBLISHED", "currently_published": true, "deleted_at": 0, "domain": "", "enable_google_amp_output_override": false, "featured_image": "https://cdn2.hubspot.net/hubfs/62515/piglet.jpg", "featured_image_alt_text": "piglet", "featured_image_height": 0, "featured_image_length": 0, "featured_image_width": 0, "flex_areas": {}, "freeze_date": 1545651277000, "has_user_changes": true, "html_title": "Test Blog", "id": 6860971618, "is_captcha_required": true, "is_draft": false, "is_instant_email_enabled": true, "is_published": true, "is_social_publishing_enabled": false, "keywords": [], "label": "Test Blog", "layout_sections": {}, "link_rel_canonical_url": "", "list_template": "generated_layouts/6208194615.html", "live_domain": "demo-hubapi.hs-sites.com", "mab": false, "mab_master": false, "mab_variant": false, "meta": { "composition_id": 442078, "author_email": "testapi@hubspot.com", "author_username": "testapi@hubspot.com", "author_user_id": 215482, "attached_stylesheets": [], "post_summary": "", "has_user_changes": true, "last_edit_session_id": null, "last_edit_update_id": null, "html_title": "Test Blog", "tag_ids": [], "topic_ids": [], "page_redirected": false, "personas": [], "placement_guids": [], "public_access_rules": [], "public_access_rules_enabled": false, "tweet_immediately": false, "unpublished_at": 0, "use_featured_image": true, "post_body": "

2-nd line

 

", "rss_summary": "

", "blog_publish_to_social_media_task": "DONE", "blog_post_schedule_task_uid": null }, "meta_description": "seo optimization", "name": "Test Blog", "page_redirected": false, "page_title": "Test Blog", "parent_blog": { "absolute_url": "http://demo-hubapi.hs-sites.com/tb-es", "allow_comments": true, "amp_body_color": "#404040", "amp_body_font": "'Helvetica Neue', Helvetica, Arial, sans-serif", "amp_body_font_size": "18", "amp_custom_css": "", "amp_header_background_color": "#ffffff", "amp_header_color": "#1e1e1e", "amp_header_font": "'Helvetica Neue', Helvetica, Arial, sans-serif", "amp_header_font_size": "36", "amp_link_color": "#416bb3", "amp_logo_alt": "", "amp_logo_height": 0, "amp_logo_src": "", "amp_logo_width": 0, "analytics_page_id": 6513512292, "attached_stylesheets": [], "captcha_after_days": 7, "captcha_always": false, "category_id": 3, "close_comments_older": 0, "comment_date_format": "medium", "comment_form_guid": "d106e4ff-1bfa-4cee-bd7e-df2c3e64ae98", "comment_max_thread_depth": 1, "comment_moderation": false, "comment_notification_emails": [], "comment_should_create_contact": false, "comment_verification_text": "", "cos_object_type": "BLOG", "created": 1542117464711, "created_date_time": 1542117464711, "daily_notification_email_id": "6513456345", "default_group_style_id": "", "default_notification_from_name": "", "default_notification_reply_to": "", "deleted_at": 0, "description": "", "domain": "", "domain_when_published": "demo-hubapi.hs-sites.com", "email_api_subscription_id": 5479310, "enable_google_amp_output": true, "enable_social_auto_publishing": false, "html_footer": "", "html_footer_is_shared": true, "html_head": "", "html_head_is_shared": true, "html_keywords": [], "html_title": "", "id": 6513512292, "instant_notification_email_id": "6513512376", "item_layout_id": 6208194615, "item_template_is_shared": true, "item_template_path": "generated_layouts/6208194615.html", "label": "Blog - ES", "listing_layout_id": 6208194615, "listing_template_path": "generated_layouts/6208194615.html", "live_domain": "demo-hubapi.hs-sites.com", "month_filter_format": "MMMM yyyy", "monthly_notification_email_id": "6513512410", "name": "Blog - ES", "portal_id": 62515, "post_html_footer": "", "post_html_head": "", "posts_per_listing_page": 10, "posts_per_rss_feed": 10, "public_access_rules": [], "public_access_rules_enabled": false, "public_title": "Blog - ES", "publish_date_format": "medium", "resolved_domain": "demo-hubapi.hs-sites.com", "root_url": "http://demo-hubapi.hs-sites.com/tb-es", "show_social_link_facebook": true, "show_social_link_google_plus": true, "show_social_link_linkedin": true, "show_social_link_twitter": true, "show_summary_in_emails": true, "show_summary_in_listing": true, "show_summary_in_rss": true, "slug": "tb-es", "social_account_twitter": "", "subscription_contacts_property": "blog_blog_es_6513512292_subscription", "subscription_form_guid": "ef80b56c-739f-4c3e-b008-e71f587cd5b6", "subscription_lists_by_type": { "daily": 483082, "instant": 483081, "monthly": 483084, "weekly": 483083 }, "updated": 1545412176504, "updated_date_time": 1545412176504, "url_base": "demo-hubapi.hs-sites.com/tb-es", "url_segments": { "all": "all", "archive": "archive", "author": "author", "page": "page", "tag": "tag" }, "use_featured_image_in_summary": true, "uses_default_template": false }, "past_mab_experiment_ids": [], "personas": [], "placement_guids": [], "portal_id": 62515, "post_body": "

", "post_body_rss": "

", "post_email_content": "", "post_list_summary_featured_image": "https://cdn2.hubspot.net/hubfs/62515/piglet.jpg", "post_rss_content": "", "post_template": "generated_layouts/6208194615.html", "preview_key": "ENbQvoGy", "processing_status": "PUBLISHED", "public_access_rules": [], "public_access_rules_enabled": false, "publish_date": 1545651277000, "publish_date_local_time": 1545651277000, "publish_date_localized": { "date": 1545651277000, "format": "medium" }, "publish_immediately": true, "published_at": 1550838546935, "published_by_email": "testapi@hubspot.com", "published_by_id": 215482, "published_by_name": "Puika Ti", "published_url": "http://demo-hubapi.hs-sites.com/tb-es/test-blog", "resolved_domain": "demo-hubapi.hs-sites.com", "rss_body": "", "rss_summary_featured_image": "https://cdn2.hubspot.net/hubfs/62515/piglet.jpg", "slug": "tb-es/test-blog", "state": "PUBLISHED", "subcategory": "normal_blog_post", "synced_with_blog_root": true, "tag_ids": [], "tag_list": [], "tag_names": [], "team_perms": [], "template_path": "", "template_path_for_render": "generated_layouts/6208194615.html", "title": "Test Blog", "topic_ids": [], "topic_list": [], "topic_names": [], "topics": [], "translated_content": {}, "tweet_immediately": false, "unpublished_at": 0, "updated": 1550838546938, "updated_by_id": 215482, "upsize_featured_image": false, "url": "http://demo-hubapi.hs-sites.com/tb-es/test-blog", "use_featured_image": true, "user_perms": [], "widget_containers": {}, "widgetcontainers": {}, "widgets": { "module_154220444615754": { "body": { "html": "

Something Powerful

Tell The Reader More

The headline and subheader tells us what you're offering, and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.

Remember:

  • Bullets are great
  • For spelling out benefits and
  • Turning visitors into leads.
" }, "child_css": {}, "css": {}, "id": "module_154220444615754", "label": "Rich text", "name": "module_154220444615754", "order": 3, "smart_type": null, "type": "rich_text" } } }