There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get a Page by ID

Last updated May 31, 2023

GET /content/api/v2/pages/:page_id

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get the details for a specific page.

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.
page_id Used in the request URL Unique identifier for a particular blog

JSON Fields returned in the response

Parameter name Type Description
ab_status string An enum with the status of the A/B test - either "master", "variant" or "loser_variant"
ab_test_id string If this page is an A/B test, this is the unique id for the test. The master, the active variants, and the loser variants, will all have the same ab_test_id
archived_at long When the page was deleted, in milliseconds since the epoch. Zero if the page was never deleted. Use a DELETE request to delete the page, do not set this directly.
archivedinDashboard bool If True, the page will not show up in your dashboard, although the page will still be live
campaign string The guid of the marketing campaign this page is associated with
campaign_name string The name of the marketing campaign this page is associated with
created long When the page was first created, in milliseconds since the epoch
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
id string The unique id of the topic
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
meta_description string A description that goes in <meta> tag on the page
meta_keywords string Keywords for the meta tag
name string The internal name of the page
password string Set this to create a password protected page. Entering the password will be required to view the page
publish_date long The date the page 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 page will live. Changing this will change the URL.
style_override_id string The ID of the style to use for this page, set this to use a different style than the default style for the site
subcategory string This is set to empty or to "landing_page" for landing pages, or to "site_page" for site pages
updated long When the page was last updated, in milliseconds since the epoch
url string The full URL with domain and scheme to the page. Will return a 404 if the page is not yet published.
widget_containers string A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.
widgets string A data structure containing the data for all the modules for this page.

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/content/api/v2/pages/352531415 Example response: { "ab_status": null, "ab_test_id": null, "analytics_page_id": "352531415", "archived": false, "attached_stylesheets": [ ], "author_user_id": 100307, "blueprint_type_id": 0, "campaign": null, "campaign_name": null, "cloned_from": null, "compose_body": null, "created": 1381896129000, "css": { }, "css_text": "", "current_live_domain": "62515.hs-sites.com", "deleted_at": 0, "deleted_by": null, "domain": "", "enable_domain_stylesheets": true, "enable_layout_stylesheets": true, "featured_image": "", "featured_image_alt_text": "", "flex_areas": { }, "folder_id": null, "footer_html": "Example Footer code", "freeze_date": 1424373283000, "has_smart_content": false, "has_user_changes": true, "head_html": "", "html_title": "The API Test Page", "id": 352531415, "include_default_custom_css": null, "is_draft": false, "keywords": [ ], "language": null, "last_edit_session_id": null, "last_edit_update_id": null, "legacy_blog_tabid": null, "meta_description": null, "meta_keywords": null, "name": "Contact Us", "page_expiry_date": null, "page_expiry_enabled": null, "page_expiry_redirect_id": null, "page_expiry_redirect_url": null, "page_redirected": null, "password": null, "performable_url": null, "personas": [ ], "portal_id": 62515, "publish_date": 1424373283000, "publish_immediately": "yes", "published_url": "http://62515.hs-sites.com/my-api-demo-page-slug", "rss_email_author_line_template": false, "rss_email_blog_image_max_width": null, "rss_email_by_text": "By", "rss_email_click_through_text": "Read more »", "rss_email_comment_text": "Comment »", "rss_email_entry_template": null, "rss_email_entry_template_enabled": false, "rss_email_image_max_width": 0, "scheduled_update_date": null, "slug": "my-api-demo-page-slug", "staged_from": null, "style_override_id": null, "subcategory": "site_page", "template_path": "generated_layouts/352531305.html", "tms_id": null, "translated_from_id": null, "unpublished_at": null, "updated": 1441239877000, "url": "http://62515.hs-sites.com/my-api-demo-page-slug", "widget_containers": { "wizard_module_126270506652874985575803835725502931337": { "widgets": [ { "body": { "name": "wizard_module_142996027130149285937051188078577857630", "is_widget_block": true, "type": "rich_text", "tag": "rich_text", "label": "Main body content", "widget_type": "rich_text", "html": "Add content here.", "overrideable": true, "export_to_template_context": false, "org_tag": "widget_block", "no_wrapper": false }, "group": 0, "body_fields": [ { "initial": "Add content here.", "type": "richtext", "name": "html", "label": "Main body content" } ], "label": "Main body content", "meta": { }, "common": { "name": "wizard_module_142996027130149285937051188078577857630", "is_widget_block": true, "type": "rich_text", "tag": "rich_text", "label": "Main body content", "widget_type": "rich_text", "html": "Add content here.", "overrideable": true, "export_to_template_context": false, "org_tag": "widget_block", "no_wrapper": false }, "key": "wizard_module_142996027130149285937051188078577857630", "order": 0, "type": "rich_text", "id": 352531400 } ] }, "right_column": { "widgets": [ { "body": { "html": "This is a meat and potatoes page of your site. You will pick a topic for the page, and edit this text to provide the visitor with all appropriate information. You might add images, calls-to-action, and videos. All this and more can be done through our text editor. You can edit this page by accessing it via the main dashboard. We hope you enjoy using the HubSpot product. If you have any questions or concerns, you can call our support." }, "type": "rich_text", "id": 352531370, "label": "Main Column Text" } ] }, "wizard_module_323305200526407577939203902949543010510": { "widgets": [ { "body": { "name": "module_1376570301869444", "is_widget_block": true, "type": "rich_text", "tag": "rich_text", "label": "Sidebar Rich Text Editor", "widget_type": "rich_text", "html": "Add content here.", "overrideable": true, "export_to_template_context": false, "org_tag": "widget_block", "no_wrapper": false }, "group": 0, "body_fields": [ { "initial": "Add content here.", "type": "richtext", "name": "html", "label": "Sidebar Rich Text Editor" } ], "label": "Sidebar Rich Text Editor", "meta": { }, "common": { "name": "module_1376570301869444", "is_widget_block": true, "type": "rich_text", "tag": "rich_text", "label": "Sidebar Rich Text Editor", "widget_type": "rich_text", "html": "Add content here", "overrideable": true, "export_to_template_context": false, "org_tag": "widget_block", "no_wrapper": false }, "key": "module_1376570301869444", "order": 0, "type": "rich_text", "id": 352531405 }, { "body": { "select_blog": "default", "name": "module_1376570851855499", "label": "Post Listing", "tag": "post_listing", "overrideable": false, "export_to_template_context": false, "list_title": "Recent Blog Posts", "listing_type": "recent", "type": "post_listing", "max_links": "5", "no_wrapper": false }, "group": 0, "body_fields": [ ], "label": "Post Listing", "meta": { }, "common": { "select_blog": "default", "name": "module_1376570851855499", "label": "Post Listing", "tag": "post_listing", "overrideable": false, "export_to_template_context": false, "list_title": "Recent Blog Posts", "listing_type": "recent", "type": "post_listing", "max_links": "5", "no_wrapper": false }, "key": "module_1376570851855499", "order": 0, "type": "post_listing", "id": 352531410 } ] } }, "widgetcontainers": { }, "widgets": { "subheader": { }, "right_column": { "body": { "html": "This text was updated via the API. This is an example of publishing nested widget data via the API." }, "smart_type": 0, "name": "right_column", "smart_objects": [ ] }, "companybyline": { "body": { "value": "Company by-line" }, "meta": { }, "type": "text", "name": "companybyline", "id": "companybyline" } } }