HubSpot: Retrieve brands by associated user

← Business units operations · Get started

Operation hubspot.business_units_get_brands

Provider route: GET /business-units/public/2026-09/business-units/user/{userId}. 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["businessUnits"]["getBrands"]>[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.businessUnits.getBrands(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.business_units.get_brands(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.userId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.name	array	Optional
query.name[]	string	Each item
query.properties	array	Optional
query.properties[]	string	Each item

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 brands by associated user — response body

Referenced models: Retrieve brands by associated user — response body

Schemas

Retrieve brands by associated user — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	The collection of Business Units
results[]	Model	Each item	Expand Retrieve brands by associated user — response body — results item

Referenced models: Retrieve brands by associated user — response body — results item

Retrieve brands by associated user — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The Business Unit's unique ID
logoMetadata	Model	Optional	Expand Retrieve brands by associated user — response body — results item logo Metadata
name	string	Required within parent	The Business Unit's name

Referenced models: Retrieve brands by associated user — response body — results item logo Metadata

Retrieve brands by associated user — response body — results item logo Metadata

Field	Type	Presence	Description and constraints
$	object	Root
logoAltText	string	Optional	The logo's alt text
logoUrl	string	Optional	The logo's url
resizedUrl	string	Optional	The logo's resized url

Policy, approvals and errors

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

Official provider source