List objects
HubSpot List Objects is a powerful tool designed to retrieve a paginated list of various HubSpot CRM objects, including contacts, deals, companies, tickets, and more. It enables users to explore data structures, access object properties, and manage CRM data efficiently with customizable filtering options.
Features
- Supports retrieval of multiple HubSpot object types such as contacts, deals, companies, tickets, products, and custom objects.
- Provides pagination support to navigate through large sets of CRM data with customizable page size up to 500 records.
- Allows specification of which object properties to return, enabling tailored data views for relevant insights.
- Supports fetching associated object IDs for comprehensive relationship mapping between CRM entities.
- Includes options to filter archived objects and manage both standard and custom HubSpot CRM records effectively.
Benefits
- Enables comprehensive data exploration to understand HubSpot object structures and improve CRM management.
- Facilitates efficient retrieval of relevant CRM data with customizable property and association parameters.
- Improves workflow automation by providing clean, paginated data for integration with other business tools.
- Reduces complexity in accessing large volumes of CRM records through intuitive pagination and filtering.
- Supports targeted marketing, sales, and customer service strategies by making CRM data more accessible and actionable.
Description
🎯 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.
Parameters
6 parameters
| Name | Type | Description |
|---|---|---|
| objectTyperequired | string | 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. |
| limit | integer | The maximum number of results to display per page (max: 500). |
| after | string | The paging cursor token of the last successfully read resource. |
| properties | string[] | A list of the properties to be returned in the response. |
| associations | string[] | 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). |
| archived | boolean | Whether to return only results that have been archived. |
