HubSpot: Retrieve folders

← Pages operations · Get started

Operation hubspot.pages_landing_pages_batch_read_folders

Provider route: POST /cms/pages/2026-09/landing-pages/folders/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"]["landingPagesBatchReadFolders"]>[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.landingPagesBatchReadFolders(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.landing_pages_batch_read_folders(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 folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder
$ (anyOf 2)	Model	Alternative	Expand Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder With Errors

Referenced models: Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder, Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder With Errors

Schemas

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 folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder

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 Create a landing page folder — 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 a landing page folder — response body

Create folders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Content Folder 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 Create a landing page folder — 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, Create a landing page folder — response body

Create a landing page folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
category	JSON	Required within parent
category (anyOf 1)	integer	Alternative	The type of object this folder applies to. Should always be LANDING_PAGE. Format: int32
category (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created	string	Required within parent	The timestamp indicating when the content folder was created. Format: date-time
deletedAt	string	Required within parent	The timestamp (ISO8601 format) when this content folder was deleted. Format: date-time
id	string	Required within parent	The unique ID of the content folder.
name	string	Required within parent	The name of the folder which will show up in the app dashboard
parentFolderId	JSON	Required within parent
parentFolderId (anyOf 1)	integer	Alternative	The ID of the content folder this folder is nested under Format: int64
parentFolderId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated	string	Required within parent	The timestamp indicating when the content folder was last updated. Format: date-time

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

Batch insert events — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail
context	object	Optional	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	string	Optional	A specific category that contains more specific detail about the error

Policy, approvals and errors

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