hubspot-list-properties
Retrieve a comprehensive catalog of properties for any HubSpot object type to understand available data structures. Use with specific object types to optimize workflows and manage data effectively.
Instructions
🎯 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| archived | No | Whether to return only properties that have been archived. | |
| includeHidden | No | Whether to include hidden properties in the response. | |
| objectType | Yes | 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. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"archived": {
"default": false,
"description": "Whether to return only properties that have been archived.",
"type": "boolean"
},
"includeHidden": {
"default": false,
"description": "Whether to include hidden properties in the response.",
"type": "boolean"
},
"objectType": {
"description": "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.",
"type": "string"
}
},
"required": [
"objectType"
],
"type": "object"
}