HubSpot: Retrieve a campaign

← Campaigns operations · Get started

Operation hubspot.campaigns_get_campaign

Provider route: GET /marketing/campaigns/2026-09/{campaignGuid}. 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"]["getCampaign"]>[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.getCampaign(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.get_campaign(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.campaignGuid	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.endDate	string	Optional
query.properties	array	Optional
query.properties[]	string	Each item
query.startDate	string	Optional

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
$	Model	Root	Expand Retrieve a campaign — response body

Referenced models: Retrieve a campaign — response body

Schemas

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

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

Retrieve assets — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the campaign asset, represented as a string.
metrics	object	Optional	A collection of performance metrics for the campaign asset, represented as a map where each key is a metric name and each value is a number. Additional keys: see wildcard field
metrics.*	JSON	Additional keys
metrics.* (anyOf 1)	number	Alternative
metrics.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Optional	The name of the campaign asset, represented as a string.

Retrieve assets — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token that serves as the paging cursor, indicating the position after the last successfully read resource.
link	string	Optional	A string URL that provides a link to the next page of results.

Retrieve campaigns — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to identify the position before the current page in the paginated results.
link	string	Optional	A URL string that provides a link to the previous page of results.

Policy, approvals and errors

SDK function policy ID: hubspot.campaigns_get_campaign. Catalog operation: campaigns_get_campaign. 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: ["data_integration.data_source.file.read", "data_integration.data_source.file.write", "marketing.campaigns.read"]

Official provider source