HubSpot: Batch retrieve campaigns

← Campaigns operations · Get started

Operation hubspot.campaigns_batch_get_campaigns

Provider route: POST /marketing/campaigns/2026-09/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["campaigns"]["batchGetCampaigns"]>[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.campaigns.batchGetCampaigns(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.campaigns.batch_get_campaigns(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.endDate	string	Optional
query.properties	array	Optional
query.properties[]	string	Each item
query.startDate	string	Optional
body	Model	Required within parent	Expand Batch retrieve campaigns — request body — body

Referenced models: Batch retrieve campaigns — 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 Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets
$ (anyOf 2)	Model	Alternative	Expand Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets With Errors

Referenced models: Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets, Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets With Errors

Schemas

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

Batch retrieve campaigns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
inputs[]	Model	Each item	Expand Batch retrieve campaigns — request body — body inputs item

Referenced models: Batch retrieve campaigns — request body — body inputs item

Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of PublicCampaignWithAssets objects, representing the campaigns involved in the batch operation.
results[]	Model	Each item	Expand Retrieve a campaign — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Retrieve a campaign — response body

Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors that occurred during the batch operation, each described by a standard error object.
errors[]	Model	Each item	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of campaigns with their associated assets that were processed in the batch operation.
results[]	Model	Each item	Expand Retrieve a campaign — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Retrieve a campaign — response body

Batch retrieve campaigns — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the campaign. It is a string and is required to retrieve the campaign details.

Retrieve a campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
assets	object	Required within parent	A map of asset types to their respective collections of campaign assets, represented by CollectionResponsePublicCampaignAsset objects. Additional keys: see wildcard field
assets.*	Model	Additional keys	Expand Retrieve a campaign — response body — assets value
businessUnits	array	Required within parent	An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
businessUnits[]	Model	Each item	Expand Create a campaign — response body — business Units item
createdAt	string	Required within parent	The date and time when the campaign was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the campaign, represented as a string.
properties	object	Required within parent	A map of custom property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
updatedAt	string	Required within parent	The date and time when the campaign was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create a campaign — response body — business Units item, Retrieve a campaign — response body — assets value

Batch create campaigns — 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	A string categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item
id	string	Optional	A string representing a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Create a campaign — response body — business Units item

Field	Type	Presence	Description and constraints
$	object	Root
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier for the business unit, represented as a 64-bit integer. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a campaign — response body — assets value

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve campaigns — response body — paging
results	array	Required within parent	An array of PublicCampaignAsset objects, each representing an individual campaign asset.
results[]	Model	Each item	Expand Retrieve assets — response body — results item

Referenced models: Retrieve campaigns — response body — paging, Retrieve assets — response body — results item

Retrieve campaigns — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve assets — response body — paging next
prev	Model	Optional	Expand Retrieve campaigns — response body — paging prev

Referenced models: Retrieve assets — response body — paging next, Retrieve campaigns — response body — paging prev

Policy, approvals and errors

SDK function policy ID: hubspot.campaigns_batch_get_campaigns. Catalog operation: campaigns_batch_get_campaigns. 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: ["marketing.campaigns.read"]

Official provider source