There's a new version of the HubSpot API

Check out the new API

Starting November 30, 2022, API keys will be sunset as an authentication method. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get the layout by ID

Last updated June 17, 2020

GET /content/api/v2/layouts/:layout_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 layout, 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.
layout_id Used in the request URL Unique identifier for a particular blog

JSON Fields returned in the response

Parameter name Type Description
body_class string The CSS class applied to the layout body
body_css_id string The CSS id applied to the layout body
category_id string The category the layout applies to
created long When the layout was first created, in milliseconds since the epoch
deleted_at long When the layout was deleted, in milliseconds since the epoch. Zero if the layout was never deleted. Use a DELETE request to delete the layout - do not set this directly.
id string The unique id of the layout
label string The name of the layout that shows up in template builder
layout_data string A complex JSON structure with the actual data for the layout
path string The path of the layout as it shows up in template builder
updated long When the layout was last updated, in milliseconds since the epoch
custom_head string Custom HTML added to the head of pages using the layout
include_default_custom_css boolean Flag to include the Primary CSS stylesheet. Defaults to use value from Site Settings. Can be overridden at the page level.
enable_domain_stylesheet boolean Flag to include the domain stylesheets for a page using the layout. Can be overridden at the page level.
attached_stylesheets array List of references to stylesheets that are attached directly to the layout. Can be overridden at the page level.

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: http://api.hubapi.com/content/api/v2/layouts/2228759063?hapikey=demo Example response: { "attached_amp_stylesheet": 0, "attached_js": [], "attached_stylesheets": [], "author": "marketplaceteam@hubspot.com", "author_at": 1548263624833, "body": { "enable_domain_stylesheets": false, "include_default_custom_css": false, "folder": "Default_Search", "attached_stylesheets": [], "cdn_purge_embargo_time": 1548263924820, "attached_js": [], "custom_head": "", "attached_amp_stylesheet": 0, "body_css_id": null, "custom_footer": "", "body_class": "", "body_css": "", "builtin": false, "purchased": false, "generator": null, "generated_template_id": 5857301778, "marketplace_good_id": 263737, "cloned_from": null, "body_editable": false, "content_tags": [ { "name": "SINGLE_COLUMN", "source": "MARKETPLACE" }, { "name": "DRAG_AND_DROP", "source": "MARKETPLACE" }, { "name": "OTHER_INDUSTRY", "source": "MARKETPLACE" }, { "name": "HIDDEN", "source": "MARKETPLACE" } ], "last_edit_session_id": null, "last_edit_update_id": null, "has_user_changes": true, "marketplace_delivery_id": 25843497, "is_read_only": true }, "body_class": "", "body_css": "", "body_editable": false, "builtin": false, "category": 1, "category_id": 1, "cdn_purge_embargo_time": 1548263924820, "content_tags": [ { "name": "SINGLE_COLUMN", "source": "MARKETPLACE" }, { "name": "DRAG_AND_DROP", "source": "MARKETPLACE" }, { "name": "OTHER_INDUSTRY", "source": "MARKETPLACE" }, { "name": "HIDDEN", "source": "MARKETPLACE" } ], "created": 1520438256581, "custom_footer": "", "custom_head": "", "default": false, "deleted_at": 0, "enable_domain_stylesheets": false, "folder": "Default_Search", "folder_id": 5500358806, "generated_template_id": 5857301778, "host_template_types": [ "ANY" ], "id": 5857301776, "include_default_custom_css": false, "is_available_for_new_content": true, "is_read_only": true, "label": "Site Search Results Page", "languages": [], "layout_data": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_1520438257026139", "is_container": false, "is_content_overridden": false, "is_in_container": false, "language_overrides": {}, "order": 0, "params": {}, "root": false, "row": false, "row_meta_data": [], "rows": [ { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_1520438257026140", "is_container": false, "is_content_overridden": false, "is_in_container": false, "language_overrides": {}, "order": 0, "params": {}, "root": false, "row": false, "row_meta_data": [], "rows": [], "section_name": "header", "type": "section_delimiter", "w": 12, "widgets": [], "x": 0 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_1520438259515148", "is_container": false, "is_content_overridden": false, "is_in_container": false, "label": "Site Search Input", "language_overrides": {}, "name": "module_1520438259515148", "order": 0, "params": { "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "custom_widget_id": 5856388301, "module_id": 2712622, "overrideable": true, "per_widget_wrapper_html": "", "schema_version": 2, "widget_name": "Search Field", "wrapping_html": "" }, "root": false, "row": false, "row_meta_data": [], "rows": [], "type": "custom_widget", "w": 12, "widgets": [], "x": 0 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_1520438261786150", "is_container": false, "is_content_overridden": false, "is_in_container": false, "label": "Site Search Results", "language_overrides": {}, "name": "module_1520438261786150", "order": 0, "params": { "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "custom_widget_id": 5856388283, "module_id": 2712624, "overrideable": true, "per_widget_wrapper_html": "", "schema_version": 2, "widget_name": "Search Results", "wrapping_html": "" }, "root": false, "row": false, "row_meta_data": [], "rows": [], "type": "custom_widget", "w": 12, "widgets": [], "x": 0 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_1520438257026141", "is_container": false, "is_content_overridden": false, "is_in_container": false, "language_overrides": {}, "order": 0, "params": {}, "root": false, "row": false, "row_meta_data": [], "rows": [], "section_name": "footer", "type": "section_delimiter", "w": 12, "widgets": [], "x": 0 } } ], "type": "cell", "w": 12, "widgets": [], "x": 0 }, "marketplace_delivery_id": 25843497, "marketplace_good_id": 263737, "meta": { "hasBufferedChanges": false }, "path": "generated_layouts/5626542347.html", "portal_id": 62515, "purchased": false, "template_type": 4, "updated": 1548263624833, "updated_by": "marketplaceteam@hubspot.com", "updated_by_id": 2411823 }