HubSpot: Retrieve budget item
HubSpot campaigns.getBudgetItem: arguments, response, policy and SDK examples.
← Campaigns operations · Get started
Operation hubspot.campaigns_get_budget_item
Provider route: GET /marketing/campaigns/2026-09/{campaignGuid}/budget/{budgetId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["getBudgetItem"]>[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.getBudgetItem(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_budget_item(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.budgetId | integer | Required within parent | Format: int64 |
path.campaignGuid | string | Required within parent |
Response
Section titled “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 Add budget item — response body |
Referenced models: Add budget item — response body
Schemas
Section titled “Schemas”Add budget item — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | The financial amount allocated to this budget item, represented as a number. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createdAt | JSON | Required within parent | |
createdAt (anyOf 1) | integer | Alternative | A Unix timestamp in milliseconds indicating when this budget item was created. Format: int64 |
createdAt (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
description | string | Optional | A description of the budget item, represented as a string. |
id | string | Required within parent | The unique identifier for this budget item, represented as a string. |
name | string | Required within parent | The name of the budget item, represented as a string. |
order | JSON | Required within parent | |
order (anyOf 1) | integer | Alternative | An integer representing the order or sequence of this budget item within the campaign. Format: int32 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updatedAt | JSON | Required within parent | |
updatedAt (anyOf 1) | integer | Alternative | A Unix timestamp in milliseconds indicating when this budget item was last updated. Format: int64 |
updatedAt (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.campaigns_get_budget_item. Catalog operation: campaigns_get_budget_item. 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"]