HubSpot: Retrieve website pages

← Pages operations · Get started

Operation hubspot.pages_batch_read_website_pages

Provider route: POST /cms/pages/2026-09/site-pages/batch/read. Alter supplies the connection’s credentials and routing.

Call through Alter

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"]["batchReadWebsitePages"]>[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.batchReadWebsitePages(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.batch_read_website_pages(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.archived	boolean	Optional
body	Model	Required within parent	Expand Delete folders — request body — body

Referenced models: Delete folders — request body — body

Response

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

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page
$ (anyOf 2)	Model	Alternative	Expand Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page With Errors

Referenced models: Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page, Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page With Errors

Schemas

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

Delete folders — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	Strings to input.
inputs[]	string	Each item

Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Time of batch operation completion. Format: date-time
links	object	Optional	Links associated with batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	Time of batch operation request. Format: date-time
results	array	Required within parent	Results of batch operation.
results[]	Model	Each item	Expand Clone a landing page — response body
startedAt	string	Required within parent	Time of batch operation start. Format: date-time
status	string	Required within parent	Status of batch operation. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a landing page — response body

Create landing pages — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Page With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	Time of batch operation completion. Format: date-time
errors	array	Optional	Errors in batch operation.
errors[]	Model	Each item	Expand Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	Links associated with batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	Number of errors. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	Time of batch operation request. Format: date-time
results	array	Required within parent	Results of batch operation.
results[]	Model	Each item	Expand Clone a landing page — response body
startedAt	string	Required within parent	Time of batch operation start. Format: date-time
status	string	Required within parent	Status of batch operation. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Clone a landing page — response body

Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	Error category.
context	object	Required within parent	Error context. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	List of error details.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	Error ID.
links	object	Required within parent	Error links. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	Error message.
status	string	Required within parent	Error status.
subCategory	object	Optional	Error subcategory.

Referenced models: Batch insert events — response body — errors item errors item

List tags — response body

Field	Type	Presence	Description and constraints
$	object	Root

Clone a landing page — response body — translations value

Field	Type	Presence	Description and constraints
$	object	Root
archivedInDashboard	boolean	Required within parent	Indicates if the page is hidden from the dashboard, though it may still be live.
authorName	string	Required within parent	The name of the user that updated this page.
campaign	string	Required within parent	The GUID of the marketing campaign this page is a part of.
campaignName	string	Required within parent	The name of the campaign associated with this language variation.
created	string	Required within parent	The date and time when the content language variation was created. Format: date-time
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	ID of object to set as primary in multi-language group. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The internal name of the page.
password	string	Required within parent	A password required to view the page, if set.
publicAccessRules	array	Required within parent	A list of rules defining public access permissions for this language variation.
publicAccessRules[]	Model	Each item	Expand List tags — response body
publicAccessRulesEnabled	boolean	Required within parent	Determines if public access rules should be respected.
publishDate	string	Required within parent	The date and time when the page is scheduled to be published. Format: date-time
slug	string	Required within parent	The path of this page, appended to the domain to construct the URL.
state	string	Required within parent	An ENUM descibing the current state of this page.
tagIds	array	Optional	A list of tag IDs associated with this language variation.
tagIds[]	JSON	Each item
tagIds[] (anyOf 1)	integer	Alternative	Format: int64
tagIds[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated	string	Required within parent	The 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

Field	Type	Presence	Description and constraints
$	object	Root
cells	array	Required within parent	The individual cells within the section, each representing a distinct area for content placement.
cells[]	Model	Each item	Expand Clone a landing page — response body — layout Sections value
cssClass	string	Required within parent	The CSS class applied to the layout section.
cssId	string	Required within parent	The CSS ID applied to the layout section.
cssStyle	string	Required within parent	Custom CSS styles applied to the layout section.
label	string	Required within parent	The label for the layout section.
name	string	Required within parent	The internal name of the page.
params	object	Required within parent	Parameters associated with the layout section. Additional keys: see wildcard field
params.*	object	Additional keys
rowMetaData	array	Required within parent	Metadata about the rows within the section, such as styling or configuration details.
rowMetaData[]	Model	Each item	Expand Clone a landing page — response body — layout Sections value row Meta Data item
rows	array	Required within parent	The number of rows contained within the section, used to organize content vertically.
rows[]	object	Each item	Additional keys: see wildcard field
rows[].*	Model	Additional keys	Expand Clone a landing page — response body — layout Sections value
styles	Model	Required within parent	Expand Clone a landing page — response body — layout Sections value styles
type	string	Required within parent	The type of the layout section.
w	JSON	Required within parent
w (anyOf 1)	integer	Alternative	The width of the layout section. Format: int32
w (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
x	JSON	Required within parent
x (anyOf 1)	integer	Alternative	The x-coordinate position of the layout section. Format: int32
x (anyOf 2)	string	Alternative	Pattern: ^-?[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

Policy, approvals and errors

SDK function policy ID: hubspot.pages_batch_read_website_pages. Catalog operation: pages_batch_read_website_pages. 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