HubSpot: Retrieve a batch of Blog Posts

← Blog posts operations · Get started

Operation hubspot.blog_posts_batch_get_posts

Provider route: POST /cms/blogs/2026-09/posts/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["blogPosts"]["batchGetPosts"]>[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.blogPosts.batchGetPosts(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.blog_posts.batch_get_posts(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 a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post
$ (anyOf 2)	Model	Alternative	Expand Create a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post With Errors

Referenced models: Create a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post, Create a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post With Errors

Schemas

11 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 a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post

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 Update a post — 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: Update a post — response body

Create a batch of blog posts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Blog Post 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 Update a post — 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, Update a post — 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

Update a post — response body — translations value

Field	Type	Presence	Description and constraints
$	object	Root
archivedInDashboard	boolean	Required within parent	If True, the variant will not show up in your dashboard, although the post could still be live.
authorName	string	Required within parent	The name of the user who last published the blog post. For posts that haven't been published yet, this property will reflect the user who initially created the draft.
campaign	string	Required within parent	The GUID of the marketing campaign this page is a part of.
campaignName	string	Required within parent	Name of the associated marketing campaign.
created	string	Required within parent	The timestamp (ISO8601 format) when this Blog Post 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 content language variation.
password	string	Required within parent	Set this to create a password protected page. Entering the password will be required to view the page.
publicAccessRules	array	Required within parent	The set of rules governing public access to this language variation.
publicAccessRules[]	Model	Each item	Expand List tags — response body
publicAccessRulesEnabled	boolean	Required within parent	Boolean to determine whether or not to respect publicAccessRules.
publishDate	string	Required within parent	The date (ISO8601 format) the page is to be published at. Format: date-time
slug	string	Required within parent	The path of the this page. This field is appended to the domain to construct the url of this page.
state	string	Required within parent	An ENUM describing the current state of this page. Maximum string length: 25
tagIds	array	Optional	An array of tag identifiers 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 timestamp (ISO8601 format) when this Blog Post was updated. Format: date-time

Referenced models: List tags — response body

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

Update a post — response body — layout Sections value row Meta Data item

Field	Type	Presence	Description and constraints
$	object	Root
cssClass	string	Required within parent	The CSS class applied to the row.
styles	Model	Required within parent	Expand Update a post — response body — layout Sections value styles

Referenced models: Update a post — response body — layout Sections value styles

Update a post — response body — layout Sections value styles background Image

Field	Type	Presence	Description and constraints
$	object	Root
backgroundPosition	string	Required within parent	Defines the position of the background image.
backgroundSize	string	Required within parent	Specifies the size of the background image.
imageUrl	string	Required within parent	The URL of the background image.

Update a post — response body — layout Sections value styles background Gradient angle

Field	Type	Presence	Description and constraints
$	object	Root
units	string	Required within parent	The unit of measurement for the angle. Known values: DEGREES, GRADIANS, RADIANS, TURNS
value	JSON	Required within parent
value (anyOf 1)	number	Alternative	The numerical representation of the angle.
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

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