Skip to content

HubSpot: List associations — discounts get Associations By To Object Type

HubSpot discounts.getAssociationsByToObjectType: arguments, response, policy and SDK examples.

← Discounts operations · Get started

Operation hubspot.discounts_get_associations_by_to_object_type

Provider route: GET /crm/objects/2026-09/discounts/{discountId}/associations/{toObjectType}. Alter supplies the connection’s credentials and routing.

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["discounts"]["getAssociationsByToObjectType"]>[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.discounts.getAssociationsByToObjectType(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.discounts.get_associations_by_to_object_type(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.discountIdstringRequired within parentPattern: .+
path.toObjectTypestringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.afterstringOptional
query.limitintegerOptionalDefault: 500
Format: int32

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List associations — discounts get Associations By To Object Type — response body

Referenced models: List associations — discounts get Associations By To Object Type — response body

List associations — discounts get Associations By To Object Type — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
pagingModelOptionalExpand List — discounts get Discounts — response body — paging
resultsarrayRequired within parentAn array of objects, each representing an association with a label. Each object contains details about the associated object and the types of associations.
results[]ModelEach itemExpand List associations — discounts get Associations By To Object Type — response body — results item

Referenced models: List — discounts get Discounts — response body — paging, List associations — discounts get Associations By To Object Type — response body — results item

List — discounts get Discounts — response body — paging
FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand List — discounts get Discounts — response body — paging next

Referenced models: List — discounts get Discounts — response body — paging next

List associations — discounts get Associations By To Object Type — response body — results item
FieldTypePresenceDescription and constraints
$objectRootRepresents an object that is associated with multiple other objects, with optional context.
associationTypesarrayRequired within parentAn array of association specifications, each including a label. These define the types of associations between the objects.
associationTypes[]ModelEach itemExpand List associations — discounts get Associations By To Object Type — response body — results item association Types item
toObjectIdstringRequired within parentThe unique identifier of the object to which associations are being made. It is a string.

Referenced models: List associations — discounts get Associations By To Object Type — response body — results item association Types item

List — discounts get Discounts — response body — paging next
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA string token used as a cursor to fetch the next page of results.
linkstringOptionalA string containing the URL link to the next page of results.
List associations — discounts get Associations By To Object Type — response body — results item association Types item
FieldTypePresenceDescription and constraints
$objectRootDefines the type, direction, and details of the relationship between two CRM objects.
categorystringRequired within parentA string representing the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'.
Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeIdstringOptionalA string representing the unique identifier of the object type from which the association originates.
labelstringOptionalA string that provides an optional label for the association, allowing for user-defined descriptions.
toObjectTypeIdstringOptionalA string representing the unique identifier of the object type to which the association points.
typeIdJSONRequired within parent
typeId (anyOf 1)integerAlternativeAn integer that uniquely identifies the type of association.
Format: int32
typeId (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: hubspot.discounts_get_associations_by_to_object_type. Catalog operation: discounts_get_associations_by_to_object_type. 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: ["crm.objects.line_items.read", "e-commerce"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.