hubspot-get-property
Retrieve detailed metadata about a specific property for HubSpot object types, including type, options, and configuration details, to ensure accurate data mapping and integration.
Instructions
🎯 Purpose:
1. This tool retrieves detailed information about a specific property for a HubSpot object type.
2. You can use this to get all metadata related to a property, including its type, options,
and other configuration details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| objectType | Yes | The type of HubSpot object the property belongs 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. | |
| propertyName | Yes | The name of the property to retrieve |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"objectType": {
"description": "The type of HubSpot object the property belongs 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.",
"type": "string"
},
"propertyName": {
"description": "The name of the property to retrieve",
"type": "string"
}
},
"required": [
"objectType",
"propertyName"
],
"type": "object"
}
Implementation Reference
- The handler function that fetches detailed information about a specific property for a given HubSpot object type using the HubSpot CRM API.async process(args) { try { const response = await this.client.get(`/crm/v3/properties/${args.objectType}/${args.propertyName}`); return { content: [ { type: 'text', text: JSON.stringify(response, null, 2), }, ], }; } catch (error) { return { content: [ { type: 'text', text: `Error retrieving HubSpot property ${args.propertyName} for ${args.objectType}: ${error instanceof Error ? error.message : String(error)}`, }, ], isError: true, }; } }
- Zod schema defining the input parameters: objectType and propertyName.const GetPropertySchema = z.object({ objectType: z .string() .describe(`The type of HubSpot object the property belongs to. Valid values include: ${HUBSPOT_OBJECT_TYPES.join(', ')}. For custom objects, use the hubspot-get-schemas tool to get the objectType.`), propertyName: z.string().describe('The name of the property to retrieve'), });
- dist/tools/properties/getPropertyTool.js:12-28 (registration)Tool definition including name, description, input schema conversion, and annotations.const ToolDefinition = { name: 'hubspot-get-property', description: ` 🎯 Purpose: 1. This tool retrieves detailed information about a specific property for a HubSpot object type. 2. You can use this to get all metadata related to a property, including its type, options, and other configuration details. `, inputSchema: zodToJsonSchema(GetPropertySchema), annotations: { title: 'Get CRM Property Details', readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true, }, };
- dist/tools/toolsRegistry.js:37-37 (registration)Registers an instance of the GetPropertyTool in the tools registry.registerTool(new GetPropertyTool());