hubspot-get-association-definitions
Read-onlyIdempotent
Retrieve valid association types between HubSpot objects to ensure proper relationship creation and troubleshoot errors.
Instructions
🎯 Purpose:
1. Retrieves valid association types between specific HubSpot object types.
📦 Returns:
1. Array of valid association definitions with type IDs, labels, and categories.
🧠Usage Guidance:
1. Always use before creating associations to ensure valid relationship types or to help troubleshoot association creation errors.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fromObjectType | Yes | The type of HubSpot object to get association from. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType. | |
| toObjectType | Yes | The type of HubSpot object to get association to. Valid values include: appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users. For custom objects, use the hubspot-get-schemas tool to get the objectType. |
Implementation Reference
- The main handler function that processes the tool input by calling the HubSpot CRM v4 API endpoint to retrieve association labels/definitions between the specified fromObjectType and toObjectType.
async process(args) { try { const response = await this.client.get(`/crm/v4/associations/${args.fromObjectType}/${args.toObjectType}/labels`); return { content: [ { type: 'text', text: JSON.stringify(response, null, 2), }, ], }; } catch (error) { return { content: [ { type: 'text', text: `Error retrieving HubSpot association schema definitions: ${error instanceof Error ? error.message : String(error)}`, }, ], isError: true, }; } } - Zod schema defining the input parameters for the tool: fromObjectType and toObjectType, with descriptions referencing valid HubSpot object types.
const AssociationSchemaDefinitionSchema = z.object({ fromObjectType: z .string() .describe(`The type of HubSpot object to get association from. Valid values include: ${HUBSPOT_OBJECT_TYPES.join(', ')}. For custom objects, use the hubspot-get-schemas tool to get the objectType.`), toObjectType: z .string() .describe(`The type of HubSpot object to get association to. Valid values include: ${HUBSPOT_OBJECT_TYPES.join(', ')}. For custom objects, use the hubspot-get-schemas tool to get the objectType.`), }); - dist/tools/toolsRegistry.js:8-8 (registration)Import statement for the AssociationSchemaDefinitionTool class.
import { AssociationSchemaDefinitionTool } from './associations/getAssociationDefinitionsTool.js'; - dist/tools/toolsRegistry.js:31-31 (registration)Instantiation and registration of the AssociationSchemaDefinitionTool using the registerTool function.
registerTool(new AssociationSchemaDefinitionTool());