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.

List layouts

Last updated May 15, 2023

GET /content/api/v2/layouts

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Get all layouts for an account. Supports paging and filtering.

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.

Optional query string filters & options

If a parameter supports a filter type of 'gt', that means you can append a double underscore to the parameter name to find all items greater than the value. For example, the following query will find all items created than the 'updated' time:
Parameter name Description
limit The number of items to return. Defaults to 20
offset The offset set to start returning rows from. Defaults to 0.
category_id exact
created exact, range, gt, gte, lt, lte
deleted_at Use a DELETE request to delete the layout - do not set this directly.
id exact, in
label exact
path exact
custom_head Custom HTML added to the head of pages using the layout.
include_default_custom_css Flag to include the Primary CSS stylesheet. Defaults to use value from Site Settings. Can be overridden at the page level.
enable_domain_stylesheet Flag to include the domain stylesheets for a page using the layout. Can be overridden at the page level.
attached_stylesheets List of references to stylesheets that are attached directly to the layout. Can be overridden at the page level.

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 layout the page, 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

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?limit=2 Example response: { "limit": 2, "objects": [ { "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 }, { "attached_amp_stylesheet": 0, "attached_js": [], "attached_stylesheets": [], "author": "marketplaceteam@hubspot.com", "author_at": 1528806862095, "body": { "enable_domain_stylesheets": false, "include_default_custom_css": false, "folder": "Defaults_-_Don't_Delete", "content_tags": [ { "name": "SINGLE_COLUMN", "source": "MARKETPLACE" }, { "name": "DRAG_AND_DROP", "source": "MARKETPLACE" }, { "name": "OTHER_INDUSTRY", "source": "MARKETPLACE" } ], "purchased": false, "attached_stylesheets": [], "cloned_from": null, "generator": "responsive_email", "body_css_id": null, "custom_head": "", "custom_footer": "", "attached_js": [], "body_class": "", "body_css": "", "builtin": false, "generated_template_id": 5869043058, "marketplace_good_id": 231306, "last_edit_update_id": null, "last_edit_session_id": null, "has_user_changes": true, "is_read_only": true }, "body_class": "", "body_css": "", "body_editable": false, "builtin": false, "category": 2, "category_id": 2, "content_tags": [ { "name": "SINGLE_COLUMN", "source": "MARKETPLACE" }, { "name": "DRAG_AND_DROP", "source": "MARKETPLACE" }, { "name": "OTHER_INDUSTRY", "source": "MARKETPLACE" } ], "created": 1528806862094, "custom_footer": "", "custom_head": "", "default": false, "deleted_at": 0, "enable_domain_stylesheets": false, "folder": "Defaults_-_Don't_Delete", "folder_id": 5500358806, "generated_template_id": 5869043058, "generator": "responsive_email", "host_template_types": [ "ANY" ], "id": 5869043056, "include_default_custom_css": false, "is_available_for_new_content": true, "is_read_only": true, "label": "New Email Template", "languages": [], "layout_data": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_151456955461526", "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_151456955461527", "is_container": false, "is_content_overridden": false, "is_in_container": false, "label": "View As Web Page", "language_overrides": {}, "name": "email_view_as_web_page", "order": 0, "params": { "html": "
Not rendering correctly? View this email as a web page here.
" }, "root": false, "row": false, "row_meta_data": [], "rows": [], "type": "email_view_as_web_page", "w": 12, "widgets": [], "x": 0 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_151456955461528", "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_151456955461529", "is_container": false, "is_content_overridden": false, "is_in_container": false, "label": "Logo", "language_overrides": {}, "name": "logo_image", "order": 0, "params": { "overrideable": true, "suppress_company_name": true }, "root": false, "row": false, "row_meta_data": [], "rows": [], "type": "logo", "w": 12, "widgets": [], "x": 0 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_151456955461530", "is_container": false, "is_content_overridden": false, "is_in_container": false, "label": "Main Email Body", "language_overrides": {}, "name": "hs_email_body", "order": 0, "params": { "default_html": "

Hi there,

Describe what you have to offer the customer. Why should they read? What did you promise them in the subject line? Tell them something cool. Make them laugh. Make them cry. Well, maybe don't do that...

Use a list to:

  • Explain the value of your offer
  • Remind the reader what they’ll get out of taking action
  • Show off your skill with bullet points
  • Make your content easy to scan

LINK TO A LANDING PAGE ON YOUR SITE (This is the really important part.)

Now wrap it all up with a pithy little reminder of how much you love them.

Aw. You silver-tongued devil, you.

Sincerely,

Your name

" }, "root": false, "row": false, "row_meta_data": [], "rows": [], "type": "email_body", "w": 12, "widgets": [], "x": 0 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_151456955461533", "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 } }, { "0": { "cell": false, "cells": [], "css_class": "", "css_id": "", "css_id_str": "", "css_style": "", "editable": false, "id": "module_151456955461534", "is_container": false, "is_content_overridden": false, "is_in_container": false, "label": "Office Location Information", "language_overrides": {}, "name": "email_can_spam", "order": 0, "params": { "html": "

              

You received this email because you are subscribed to from HubSpot.

Update your email preferences to choose the types of emails you receive.

 Unsubscribe from all future emails  

" }, "root": false, "row": false, "row_meta_data": [], "rows": [], "type": "email_can_spam", "w": 12, "widgets": [], "x": 0 } } ], "type": "cell", "w": 12, "widgets": [], "x": 0 }, "marketplace_good_id": 231306, "meta": { "hasBufferedChanges": false }, "path": "generated_layouts/5869043056.html", "portal_id": 62515, "purchased": false, "template_type": 2, "updated": 1528806862095, "updated_by": "marketplaceteam@hubspot.com" } ], "offset": 0, "total": 46, "total_count": 46 }