hubspot-search-objects
Search HubSpot CRM objects using advanced filters and criteria to retrieve targeted data with pagination support.
Instructions
🎯 Purpose:
1. Performs advanced filtered searches across HubSpot object types using complex criteria.
📋 Prerequisites:
1. Use the hubspot-list-objects tool to sample existing objects for the object type.
2. If hubspot-list-objects tool's response isn't helpful, use hubspot-list-properties tool.
📦 Returns:
1. Filtered collection matching specific criteria with pagination information.
🧭 Usage Guidance:
1. Preferred for targeted data retrieval when exact filtering criteria are known. Supports complex boolean logic through filter groups.
2. Use hubspot-list-objects when filter criteria is not specified or clear or when a search fails.
3. Use hubspot-batch-read-objects to retrieve specific objects by their IDs.
4. Use hubspot-list-associations to get the associations between objects.
🔍 Filtering Capabilities:
1. Think of "filterGroups" as separate search conditions that you want to combine with OR logic (meaning ANY of them can match).
2. If you want to find things that match ALL of several conditions (AND logic), put those conditions together in the same filters list.
3. If you want to find things that match AT LEAST ONE of several conditions (OR logic), put each condition in a separate filterGroup.
4. You can include a maximum of five filterGroups with up to 6 filters in each group, with a maximum of 18 filters in total.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| objectType | Yes | The type of HubSpot object to search. 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. | |
| query | No | Text to search across default searchable properties of the specified object type. Each object type has different searchable properties. For example: contacts (firstname, lastname, email, phone, company), companies (name, website, domain, phone), deals (dealname, pipeline, dealstage, description, dealtype), etc | |
| limit | No | The maximum number of results to display per page (max: 100). | |
| after | No | The paging cursor token of the last successfully read resource. | |
| properties | No | A list of the properties to be returned in the response. | |
| sorts | No | A list of sort criteria to apply to the results. | |
| filterGroups | No | Groups of filters to apply (combined with OR). |
Implementation Reference
- Executes the HubSpot CRM object search by constructing a request body from input parameters, calling the HubSpot API search endpoint, and formatting the response with results and pagination.async process(args) { try { const { query, limit, after, properties, sorts, filterGroups } = args; const requestBody = { query, limit, after, properties: properties && properties.length > 0 ? properties : undefined, sorts: sorts && sorts.length > 0 ? sorts : undefined, filterGroups: filterGroups && filterGroups.length > 0 ? filterGroups : undefined, }; const cleanRequestBody = Object.fromEntries(Object.entries(requestBody).filter(([_, value]) => value !== undefined)); const response = await this.client.post(`/crm/v3/objects/${args.objectType}/search`, { body: cleanRequestBody, }); return { content: [ { type: 'text', text: JSON.stringify({ results: response.results.map(item => ({ id: item.id, properties: item.properties, createdAt: item.createdAt, updatedAt: item.updatedAt, archived: item.archived, archivedAt: item.archivedAt, })), paging: response.paging, }, null, 2), }, ], }; } catch (error) { return { content: [ { type: 'text', text: `Error searching HubSpot ${args.objectType}: ${error instanceof Error ? error.message : String(error)}`, }, ], isError: true, }; } }
- Zod schema defining the input parameters for the tool, including objectType, query, limit, pagination, properties, sorts, and complex filterGroups.const ObjectSearchSchema = z.object({ objectType: z .string() .describe(`The type of HubSpot object to search. Valid values include: ${HUBSPOT_OBJECT_TYPES.join(', ')}. For custom objects, use the hubspot-get-schemas tool to get the objectType.`), query: z .string() .optional() .describe('Text to search across default searchable properties of the specified object type. Each object type has different searchable properties. For example: contacts (firstname, lastname, email, phone, company), companies (name, website, domain, phone), deals (dealname, pipeline, dealstage, description, dealtype), etc'), limit: z .number() .int() .min(1) .max(100) .default(10) .describe('The maximum number of results to display per page (max: 100).'), after: z .string() .optional() .describe('The paging cursor token of the last successfully read resource.'), properties: z .array(z.string()) .optional() .describe('A list of the properties to be returned in the response.'), sorts: z .array(SortSchema) .optional() .describe('A list of sort criteria to apply to the results.'), filterGroups: z .array(FilterGroupSchema) .optional() .describe('Groups of filters to apply (combined with OR).'), });
- dist/tools/toolsRegistry.js:29-29 (registration)Registers an instance of the ObjectSearchTool (which implements hubspot-search-objects) with the central tools registry.registerTool(new ObjectSearchTool());
- Tool definition object containing the name 'hubspot-search-objects', detailed description, JSON schema from Zod, and annotations passed to BaseTool constructor.const ToolDefinition = { name: 'hubspot-search-objects', description: ` 🎯 Purpose: 1. Performs advanced filtered searches across HubSpot object types using complex criteria. 📋 Prerequisites: 1. Use the hubspot-list-objects tool to sample existing objects for the object type. 2. If hubspot-list-objects tool's response isn't helpful, use hubspot-list-properties tool. 📦 Returns: 1. Filtered collection matching specific criteria with pagination information. 🧭 Usage Guidance: 1. Preferred for targeted data retrieval when exact filtering criteria are known. Supports complex boolean logic through filter groups. 2. Use hubspot-list-objects when filter criteria is not specified or clear or when a search fails. 3. Use hubspot-batch-read-objects to retrieve specific objects by their IDs. 4. Use hubspot-list-associations to get the associations between objects. 🔍 Filtering Capabilities: 1. Think of "filterGroups" as separate search conditions that you want to combine with OR logic (meaning ANY of them can match). 2. If you want to find things that match ALL of several conditions (AND logic), put those conditions together in the same filters list. 3. If you want to find things that match AT LEAST ONE of several conditions (OR logic), put each condition in a separate filterGroup. 4. You can include a maximum of five filterGroups with up to 6 filters in each group, with a maximum of 18 filters in total. `, inputSchema: zodToJsonSchema(ObjectSearchSchema), annotations: { title: 'Search CRM Objects', readOnlyHint: true, destructiveHint: false, idempotentHint: false, openWorldHint: true, }, };
- dist/tools/toolsRegistry.js:6-6 (registration)Imports the ObjectSearchTool class required for registration.import { ObjectSearchTool } from './objects/searchObjectsTool.js';