List properties
HubSpot List Properties is an advanced API tool designed to retrieve a comprehensive catalog of properties for any specified HubSpot object type, enabling users to explore and utilize CRM data structures effectively. Ideal for developers and marketers, it simplifies accessing detailed metadata about contacts, deals, companies, and more within HubSpot.
Features
- Retrieve complete property lists for various HubSpot object types including contacts, deals, companies, and custom objects.
- Filter properties by archived status to manage active and inactive data efficiently.
- Option to include hidden properties to gain deeper insights into all available data fields.
- Supports large data responses with guidance on optimizing API calls using related tools like hubspot-list-objects and hubspot-get-property.
- Facilitates better workflow automation by providing clear visibility into HubSpot's data structure at the start of integration processes.
Benefits
- Gain full visibility into CRM property metadata to enhance data management and personalization.
- Optimize marketing and sales workflows by understanding the exact data available for each HubSpot object.
- Improve API efficiency by sampling objects and fetching specific properties as needed, reducing token consumption.
- Enable robust custom object handling by identifying all relevant fields through schema exploration.
- Streamline integration and automation development with accurate and up-to-date property catalogs.
Description
🎯 Purpose: 1. This tool retrieves a complete catalog of properties for any HubSpot object type. 🧭 Usage Guidance: 1. This API has a large response that can consume a lot of tokens. Use the hubspot-list-objects tool to sample existing objects for the object type first. 2. Try to use the hubspot-get-property tool to get a specific property. 3. Use at the beginning of workflows to understand available data structures.
Parameters
3 parameters
| Name | Type | Description |
|---|---|---|
| objectTyperequired | string | The type of HubSpot object to get properties for. 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. |
| archived | boolean | Whether to return only properties that have been archived. |
| includeHidden | boolean | Whether to include hidden properties in the response. |
