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

← Invoices operations · Get started

Operation hubspot.invoices_get_associations_by_to_object_type

Provider route: GET /crm/objects/2026-09/invoices/{invoiceId}/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["invoices"]["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.invoices.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.invoices.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.invoiceId	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 — invoices get Associations By To Object Type — response body

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

Schemas

List associations — invoices 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 — invoices get Invoices — response body — paging
results	array	Required within parent	An array of objects, each representing an association with multiple labels. Each object contains details about the association types and the associated object ID.
results[]	Model	Each item	Expand List associations — invoices get Associations By To Object Type — response body — results item

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

List — invoices get Invoices — 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 — invoices get Invoices — response body — paging next

Referenced models: List — invoices get Invoices — response body — paging next

List associations — invoices 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, each including a label. These define the types of associations between the objects.
associationTypes[]	Model	Each item	Expand List associations — invoices get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the target object to which associations are made. It is a string.

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

List — invoices get Invoices — 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 used as a cursor to indicate the starting point for the next page of results.
link	string	Optional	A URL string that provides the direct link to access the next page of results.

List associations — invoices 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, indicating its origin or purpose. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the type ID of the object from which the association originates.
label	string	Optional	A string label that describes the association.
toObjectTypeId	string	Optional	A string representing the type ID of the object to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the 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.invoices_get_associations_by_to_object_type. Catalog operation: invoices_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.invoices.read"]

Official provider source