Skip to content

HubSpot: Retrieve a landing page

HubSpot pages.getLandingPage: arguments, response, policy and SDK examples.

← Pages operations · Get started

Operation hubspot.pages_get_landing_page

Provider route: GET /cms/pages/2026-09/landing-pages/{objectId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["pages"]["getLandingPage"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.pages.getLandingPage(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.pages.get_landing_page(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.objectIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.archivedbooleanOptional
query.propertystringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Clone a landing page — response body

Referenced models: Clone a landing page — response body

9 more schemas are linked from the tables above, on the schema pages.

List tags — response body
FieldTypePresenceDescription and constraints
$objectRoot
Clone a landing page — response body — translations value
FieldTypePresenceDescription and constraints
$objectRoot
archivedInDashboardbooleanRequired within parentIndicates if the page is hidden from the dashboard, though it may still be live.
authorNamestringRequired within parentThe name of the user that updated this page.
campaignstringRequired within parentThe GUID of the marketing campaign this page is a part of.
campaignNamestringRequired within parentThe name of the campaign associated with this language variation.
createdstringRequired within parentThe date and time when the content language variation was created.
Format: date-time
idJSONRequired within parent
id (anyOf 1)integerAlternativeID of object to set as primary in multi-language group.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentThe internal name of the page.
passwordstringRequired within parentA password required to view the page, if set.
publicAccessRulesarrayRequired within parentA list of rules defining public access permissions for this language variation.
publicAccessRules[]ModelEach itemExpand List tags — response body
publicAccessRulesEnabledbooleanRequired within parentDetermines if public access rules should be respected.
publishDatestringRequired within parentThe date and time when the page is scheduled to be published.
Format: date-time
slugstringRequired within parentThe path of this page, appended to the domain to construct the URL.
statestringRequired within parentAn ENUM descibing the current state of this page.
tagIdsarrayOptionalA list of tag IDs associated with this language variation.
tagIds[]JSONEach item
tagIds[] (anyOf 1)integerAlternativeFormat: int64
tagIds[] (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedstringRequired within parentThe date and time when the content language variation was last updated.
Format: date-time

Referenced models: List tags — response body

Clone a landing page — response body — layout Sections value
FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe individual cells within the section, each representing a distinct area for content placement.
cells[]ModelEach itemExpand Clone a landing page — response body — layout Sections value
cssClassstringRequired within parentThe CSS class applied to the layout section.
cssIdstringRequired within parentThe CSS ID applied to the layout section.
cssStylestringRequired within parentCustom CSS styles applied to the layout section.
labelstringRequired within parentThe label for the layout section.
namestringRequired within parentThe internal name of the page.
paramsobjectRequired within parentParameters associated with the layout section.
Additional keys: see wildcard field
params.*objectAdditional keys
rowMetaDataarrayRequired within parentMetadata about the rows within the section, such as styling or configuration details.
rowMetaData[]ModelEach itemExpand Clone a landing page — response body — layout Sections value row Meta Data item
rowsarrayRequired within parentThe number of rows contained within the section, used to organize content vertically.
rows[]objectEach itemAdditional keys: see wildcard field
rows[].*ModelAdditional keysExpand Clone a landing page — response body — layout Sections value
stylesModelRequired within parentExpand Clone a landing page — response body — layout Sections value styles
typestringRequired within parentThe type of the layout section.
wJSONRequired within parent
w (anyOf 1)integerAlternativeThe width of the layout section.
Format: int32
w (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
xJSONRequired within parent
x (anyOf 1)integerAlternativeThe x-coordinate position of the layout section.
Format: int32
x (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Clone a landing page — response body — layout Sections value, Clone a landing page — response body — layout Sections value row Meta Data item, Clone a landing page — response body — layout Sections value styles

Clone a landing page — response body — layout Sections value row Meta Data item
FieldTypePresenceDescription and constraints
$objectRoot
cssClassstringRequired within parentThe CSS class applied to the row metadata.
stylesModelRequired within parentExpand Clone a landing page — response body — layout Sections value styles

Referenced models: Clone a landing page — response body — layout Sections value styles

Clone a landing page — response body — layout Sections value styles
FieldTypePresenceDescription and constraints
$objectRoot
backgroundColorModelRequired within parentExpand Update a post — response body — layout Sections value styles background Color
backgroundGradientModelRequired within parentExpand Clone a landing page — response body — layout Sections value styles background Gradient
backgroundImageModelRequired within parentExpand Update a post — response body — layout Sections value styles background Image
breakpointStylesobjectOptionalContains style settings specific to different breakpoints. This property allows for responsive design adjustments based on screen size.
Additional keys: see wildcard field
breakpointStyles.*ModelAdditional keysExpand Clone a landing page — response body — layout Sections value styles breakpoint Styles value
flexboxPositioningstringRequired within parentIndicates whether flexbox positioning is enabled for the section.
Known values: BOTTOM_CENTER, BOTTOM_LEFT, BOTTOM_RIGHT, MIDDLE_CENTER, MIDDLE_LEFT, MIDDLE_RIGHT, TOP_CENTER, TOP_LEFT, TOP_RIGHT
forceFullWidthSectionbooleanRequired within parentDetermines if the section should be forced to full width.
maxWidthSectionCenteringJSONRequired within parent
maxWidthSectionCentering (anyOf 1)integerAlternativeDefines the maximum width for centering the section.
Format: int32
maxWidthSectionCentering (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
verticalAlignmentstringRequired within parentSpecifies the vertical alignment of elements within the section.
Known values: BOTTOM, MIDDLE, TOP

Referenced models: Update a post — response body — layout Sections value styles background Image, Clone a landing page — response body — layout Sections value styles breakpoint Styles value, Clone a landing page — response body — layout Sections value styles background Gradient, Update a post — response body — layout Sections value styles background Color

Update a post — response body — layout Sections value styles background Image
FieldTypePresenceDescription and constraints
$objectRoot
backgroundPositionstringRequired within parentDefines the position of the background image.
backgroundSizestringRequired within parentSpecifies the size of the background image.
imageUrlstringRequired within parentThe URL of the background image.
Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin
FieldTypePresenceDescription and constraints
$objectRoot
bottomModelRequired within parentExpand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top
topModelRequired within parentExpand Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top

Referenced models: Clone a landing page — response body — layout Sections value styles breakpoint Styles value margin top

SDK function policy ID: hubspot.pages_get_landing_page. Catalog operation: pages_get_landing_page. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["content"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.