hubspot-list-objects
Retrieve a paginated list of HubSpot objects by type to explore data structure, properties, and metadata. Ideal for initial data exploration when search criteria are unclear. Supports custom properties and associations.
Instructions
🎯 Purpose:
1. Retrieves a paginated list of objects of a specified type from HubSpot.
📦 Returns:
1. Collection of objects with their properties and metadata, plus pagination information.
🧭 Usage Guidance:
1. Use for initial data exploration to understand the data structure of a HubSpot object type.
2. Helps list objects when the search criteria or filter criteria is not clear.
3. Use hubspot-search-objects for targeted queries when the data structure is known.
4. Use hubspot-batch-read-objects to retrieve specific objects by their IDs.
5. Use hubspot-list-associations to list associations between objects.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | The paging cursor token of the last successfully read resource. | |
| archived | No | Whether to return only results that have been archived. | |
| associations | No | A list of object types to retrieve associated IDs for (e.g., appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users). | |
| limit | No | The maximum number of results to display per page (max: 500). | |
| objectType | Yes | The type of HubSpot object to list. 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. | |
| properties | No | A list of the properties to be returned in the response. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"after": {
"description": "The paging cursor token of the last successfully read resource.",
"type": "string"
},
"archived": {
"default": false,
"description": "Whether to return only results that have been archived.",
"type": "boolean"
},
"associations": {
"description": "A list of object types to retrieve associated IDs for (e.g., appointments, companies, contacts, courses, deals, leads, line_items, listings, marketing_events, meetings, orders, postal_mail, products, quotes, services, subscriptions, tickets, users).",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"default": 100,
"description": "The maximum number of results to display per page (max: 500).",
"maximum": 500,
"minimum": 1,
"type": "integer"
},
"objectType": {
"description": "The type of HubSpot object to list. 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"
},
"properties": {
"description": "A list of the properties to be returned in the response.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"objectType"
],
"type": "object"
}