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

← Listings operations · Get started

Operation hubspot.listings_get_associations_by_to_object_type

Provider route: GET /crm/objects/2026-09/listings/{listingId}/associations/{toObjectType}. 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["listings"]["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.listings.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.listings.get_associations_by_to_object_type(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.listingId	string	Required within parent	Pattern: .+
path.toObjectType	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.after	string	Optional
query.limit	integer	Optional	Default: 500 Format: int32

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 List associations — listings get Associations By To Object Type — response body

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

Schemas

List associations — listings get Associations By To Object Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents 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.
paging	Model	Optional	Expand List — listings get Listings — response body — paging
results	array	Required within parent	An array of objects, each representing an associated object with labels. Each object contains details about the association types and the ID of the associated object.
results[]	Model	Each item	Expand List associations — listings get Associations By To Object Type — response body — results item

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

List — listings get Listings — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List — listings get Listings — response body — paging next

Referenced models: List — listings get Listings — response body — paging next

List associations — listings get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association specifications with labels, detailing the types and labels of associations for the object.
associationTypes[]	Model	Each item	Expand List associations — listings get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The ID of the object that is being associated.

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

List — listings get Listings — 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 a cursor for fetching the next page of results. It is used to identify the position after the last item of the current page.
link	string	Optional	A URL string that provides a direct link to the next page of results. This link can be used to make a subsequent API call to retrieve additional data.

List associations — listings get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	The category of the association, with possible values: HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	The object type ID from which the association originates.
label	string	Optional	A human-readable label for the association.
toObjectTypeId	string	Optional	The object type ID to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	The identifier for the specific type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.listings_get_associations_by_to_object_type. Catalog operation: listings_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.listings.read"]

Official provider source