HubSpot
Overview
Section titled “Overview”HubSpot is an inbound marketing, sales, and customer service platform integrating CRM, email automation, and analytics to facilitate lead nurturing and seamless customer experiences. With the HubSpot integration in SquadOS, your agents can create and update contacts, deals, companies, and tickets, run advanced CRM searches, and automate workflows without any manual intervention.
- Official website: https://www.hubspot.com/
- Composio documentation: docs.composio.dev/toolkits/hubspot
Authentication
Section titled “Authentication”This tool supports two authentication modes: OAuth 2.0 (OAUTH2) and API key (API_KEY). OAuth 2.0 is recommended for most use cases, as it does not require manual token generation.
OAuth 2.0
Section titled “OAuth 2.0”In OAuth mode, you authorize access directly on the Composio connection page — no need to generate credentials manually.
API Key (API_KEY)
Section titled “API Key (API_KEY)”You will need the following fields:
| Field | Required | Description |
|---|---|---|
api_key | Yes | Your HubSpot private API key. Go to Settings → Integrations → API Key in the HubSpot dashboard. |
How to get credentials
Section titled “How to get credentials”For detailed instructions on setting up OAuth credentials or an API key for HubSpot in Composio, see: composio.dev/auth/hubspot.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
HubSpot. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you authorize access via OAuth 2.0 or enter the API key obtained above.
- Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)
How do I set up custom OAuth credentials for HubSpot?
Section titled “How do I set up custom OAuth credentials for HubSpot?”For a step-by-step guide on creating and configuring your own HubSpot OAuth credentials with Composio, see How to create OAuth credentials for HubSpot.
Why am I getting errors with limit on HubSpot contact searches?
Section titled “Why am I getting errors with limit on HubSpot contact searches?”The HUBSPOT_SEARCH_CONTACTS_BY_CRITERIA and HUBSPOT_LIST_CONTACTS_PAGE tools have a maximum limit of 100 results per request. Set limit to 100 or lower to avoid errors.
Why can’t I set up webhooks for HubSpot?
Section titled “Why can’t I set up webhooks for HubSpot?”HubSpot webhooks require a public app with an App ID and Developer API Key. Private or internal apps cannot receive webhooks.
Available actions
Section titled “Available actions”Get account information
Section titled “Get account information”HUBSPOT_GET_ACCOUNT_INFO
Gets current HubSpot account info (email, hubId, user details) using access-token lookup.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List contacts
Section titled “List contacts”HUBSPOT_LIST_CONTACTS
Retrieves a paginated list of HubSpot contacts.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination token from paging.next.after of a previous response, used to fetch the subsequent page. Omit for the first page. |
limit | integer | No | Maximum number of contacts to return per page (default: 10). |
archived | boolean | No | true returns only archived contacts; false (default) returns only active contacts. |
properties | array | No | List of contact property internal names to include in the response. |
associations | array | No | List of object types (e.g., companies, deals) for which to retrieve associated IDs with each contact. |
propertiesWithHistory | array | No | List of property internal names for which to retrieve historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Search contacts by criteria
Section titled “Search contacts by criteria”HUBSPOT_SEARCH_CONTACTS_BY_CRITERIA
Searches for HubSpot contacts using a text query, specific filter criteria (filters in a group are ANDed, groups are ORed), sorting, and pagination to retrieve selected properties.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | The cursor token for pagination. Use the after value from paging.next of a previous response. |
limit | integer | No | The maximum number of contacts to return. Maximum 100. |
query | string | No | A string to search across default searchable contact properties only: firstname, lastname, email, phone, company. Does NOT search custom properties — use filterGroups for that. |
sorts | array | No | A list of sort criteria. Example: [{'propertyName': 'lastname', 'direction': 'ASCENDING'}]. |
properties | array | No | A list of contact property internal names to include in the response. |
filterGroups | array | No | A list of filter groups. Maximum 5 groups and 18 total filters. Filters within a group are ANDed; groups are ORed. |
custom_properties | array | No | Internal names of custom properties to retrieve (convenience alias merged into properties). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Read contact
Section titled “Read contact”HUBSPOT_READ_CONTACT
Retrieves a HubSpot contact by its ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
contactId | string | Yes | Unique internal HubSpot CRM object ID for the contact. |
archived | boolean | No | Set to true to include only archived contacts; defaults to false (active contacts). |
properties | array | No | Contact property names to include in the response. |
associations | array | No | Object types (e.g., companies, deals) to include associated object IDs. |
propertiesWithHistory | array | No | Property names for which to include historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create contact
Section titled “Create contact”HUBSPOT_CREATE_CONTACT
Creates a new HubSpot contact.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
email | string | No | The primary email address of the contact. This is a unique identifier for contacts in HubSpot. |
firstname | string | No | The contact’s first name. |
lastname | string | No | The contact’s last name. |
phone | string | No | The contact’s primary phone number. |
company | string | No | The name of the company the contact works for. |
jobtitle | string | No | The contact’s job title. |
website | string | No | The URL of the contact’s personal or company website. |
associations | array | No | List of associations to create with other existing HubSpot objects (e.g., companies, deals). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Update contact
Section titled “Update contact”HUBSPOT_UPDATE_CONTACT
Updates properties for an existing HubSpot contact.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
contactId | string | Yes | Unique HubSpot identifier for the contact to be updated. |
properties | object | No | Standard HubSpot contact properties to update. |
custom_properties | object | No | Custom HubSpot properties to update. Keys must be the internal property names (e.g., my_custom_field). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Merge contacts
Section titled “Merge contacts”HUBSPOT_MERGE_CONTACTS
Merges two HubSpot contacts into one.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
primaryObjectId | string | Yes | The ID of the contact record that will remain after the merge and absorb the information from the other contact. |
objectIdToMerge | string | Yes | The ID of the contact record that will be merged into the primary contact and deleted after the merge. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List contact properties
Section titled “List contact properties”HUBSPOT_LIST_CONTACT_PROPERTIES
Lists all contact properties in your HubSpot account, including custom properties. Useful for discovering internal property names to use in filters and updates.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
archived | boolean | No | Whether to include archived properties. |
custom_only | boolean | No | Filter to only return custom properties (excludes HubSpot default properties). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List companies
Section titled “List companies”HUBSPOT_LIST_COMPANIES
Retrieves a paginated list of HubSpot companies.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination token from a previous response to fetch the subsequent page. |
limit | integer | No | Maximum number of companies to return per page (default: 10). |
archived | boolean | No | true returns only archived companies; false (default) returns only active companies. |
properties | array | No | List of company property internal names to include in the response. |
associations | array | No | List of object types for which to retrieve associated IDs with each company. |
propertiesWithHistory | array | No | List of property internal names for which to retrieve historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Search companies
Section titled “Search companies”HUBSPOT_SEARCH_COMPANIES
Searches for HubSpot companies using flexible criteria and filters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination cursor; use paging.next.after from a previous response. |
limit | integer | No | Maximum number of company records to return. |
query | string | No | String to search across default text properties of company records. |
sorts | array | No | List of sort objects to define the order of results. Maximum 1 sort allowed. |
properties | array | No | HubSpot company property internal names to include in the response. |
filterGroups | array | No | List of filter groups; filters within a group are ANDed, and multiple groups are ORed. |
custom_properties | array | No | Custom company property internal names to include in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get company
Section titled “Get company”HUBSPOT_GET_COMPANY
Retrieves a HubSpot company by its ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
companyId | string | Yes | Unique HubSpot identifier for the company to retrieve. |
archived | boolean | No | Set to true to include only archived companies; defaults to false. |
properties | array | No | Company property names to include in the response. Use "all" to retrieve all properties. |
associations | array | No | Object types to include associated object IDs. |
propertiesWithHistory | array | No | Property names for which to include historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create company
Section titled “Create company”HUBSPOT_CREATE_COMPANY
Creates a new HubSpot company.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Company name. |
domain | string | No | Company’s primary domain name. |
phone | string | No | Company’s primary phone number. |
website | string | No | Company’s website URL. |
city | string | No | City where the company is located. |
state | string | No | State or region where the company is located. |
country | string | No | Country where the company is located. |
industry | string | No | The type of business the company performs. Must be one of HubSpot’s predefined industry enum values in SCREAMING_SNAKE_CASE (e.g., COMPUTER_SOFTWARE, FINANCIAL_SERVICES). |
description | string | No | Brief description of the company. |
annualrevenue | string | No | Company’s annual revenue. |
associations | array | No | List of associations to create with other existing HubSpot objects. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Update company
Section titled “Update company”HUBSPOT_UPDATE_COMPANY
Updates properties for an existing HubSpot company.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
companyId | string | Yes | Unique HubSpot identifier for the company to be updated. |
properties | object | Yes | Company properties to update. Keys are internal HubSpot property names. Use an empty string to clear a property. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List deals
Section titled “List deals”HUBSPOT_LIST_DEALS
Retrieves a paginated list of HubSpot deals.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination token from a previous response to fetch the subsequent page. |
limit | integer | No | Maximum number of deals to return per page (default: 10, maximum: 100). |
archived | boolean | No | Filter by archived status: true for archived deals, false for active deals. |
properties | array | No | List of deal property names to include in the response. |
associations | array | No | List of object types for which to retrieve associated IDs. |
propertiesWithHistory | array | No | List of property names for which to retrieve historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Search deals
Section titled “Search deals”HUBSPOT_SEARCH_DEALS
Searches for HubSpot deals using flexible criteria and filters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination token from a previous response. HubSpot’s search API has a hard limit of 10,000 total results. |
limit | integer | No | Maximum number of deal records to return. |
query | string | No | String to search across default text properties in deals. |
sorts | array | No | Sort order for results. |
properties | array | No | HubSpot deal property internal names to include in the response. |
filterGroups | array | No | Filter groups to apply to the search. Filters within a group are ANDed; groups are ORed. |
custom_properties | array | No | User-defined custom property internal names to include in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get deal
Section titled “Get deal”HUBSPOT_GET_DEAL
Retrieves a HubSpot deal by its ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
dealId | string | Yes | Unique HubSpot identifier for the deal to retrieve. |
archived | boolean | No | Set to true to include only archived deals; defaults to false. |
properties | array | No | Deal property names to include in the response. |
associations | array | No | Object types for which to retrieve associated IDs. |
propertiesWithHistory | array | No | Property names for which to include historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create deal
Section titled “Create deal”HUBSPOT_CREATE_DEAL
Creates a new HubSpot deal.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
dealname | string | No | Descriptive name or title of the deal. |
amount | string | No | Total monetary value of the deal. |
pipeline | string | No | ID of the sales pipeline for this deal (required in practice). |
dealstage | string | No | Valid pipeline stage ID. Stage IDs must be actual values from your HubSpot pipeline configuration. |
closedate | string | No | Date (YYYY-MM-DD) or datetime (ISO 8601) when the deal closed or is expected to close. |
dealtype | string | No | Type of deal (e.g., newbusiness, existingbusiness). |
description | string | No | Detailed text description of the deal. |
associations | array | No | Associations to create between the new deal and other CRM objects. |
hubspot_owner_id | string | No | ID of the HubSpot user owning the deal. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Update deal
Section titled “Update deal”HUBSPOT_UPDATE_DEAL
Updates properties for an existing HubSpot deal.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
dealId | string | Yes | Unique HubSpot identifier for the deal to be updated. |
properties | object | Yes | Deal properties to update. Must contain at least one property. Keys are internal HubSpot property names. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List tickets
Section titled “List tickets”HUBSPOT_LIST_TICKETS
Retrieves a paginated list of HubSpot support tickets.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination token to fetch the next page. |
limit | integer | No | Maximum number of tickets to return per page. |
archived | boolean | No | true for archived tickets; false (default) for active tickets. |
properties | array | No | Ticket property names to include in the response. |
associations | array | No | Object types for which to retrieve associated IDs. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Search tickets
Section titled “Search tickets”HUBSPOT_SEARCH_TICKETS
Searches for HubSpot tickets using flexible criteria and filters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Cursor token for pagination to get the next page of results. |
limit | integer | No | Maximum number of tickets to return in the response. |
query | string | No | Text search query to find tickets by content or subject. |
sorts | array | No | List of sort criteria for ordering the results. |
properties | array | No | Ticket properties to include in the response. Supports both standard and custom properties. |
filterGroups | array | No | Groups of filters to apply to the ticket search. |
custom_properties | array | No | List of custom property names to include in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Get ticket
Section titled “Get ticket”HUBSPOT_GET_TICKET
Retrieves a HubSpot ticket by its ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
ticketId | string | Yes | Unique HubSpot identifier for the ticket to retrieve. |
archived | boolean | No | Filter by archived status. |
properties | array | No | Ticket property names to include in the response. |
associations | array | No | Object types for which to retrieve associated IDs. |
propertiesWithHistory | array | No | Property names for which to include historical values. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create ticket
Section titled “Create ticket”HUBSPOT_CREATE_TICKET
Creates a new HubSpot support ticket.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
subject | string | No | Subject line or title of the ticket; typically a required field in practice. |
content | string | No | Main body or description of the ticket, detailing the issue or request. |
hs_pipeline | string | No | ID of the pipeline this ticket belongs to; often a required field. |
hs_pipeline_stage | string | No | ID of the current stage of the ticket within its pipeline. |
hs_ticket_priority | string | No | Priority of the ticket: HIGH, MEDIUM, or LOW. |
hs_ticket_category | string | No | Category of the ticket: PRODUCT_ISSUE, BILLING_ISSUE, FEATURE_REQUEST, or GENERAL_INQUIRY. |
source_type | string | No | Source channel through which the ticket was created: CHAT, EMAIL, FORM, or PHONE. |
hubspot_owner_id | string | No | ID of the HubSpot user who owns this ticket. |
associations | array | No | List defining associations between this new ticket and other existing HubSpot objects. |
custom_properties | object | No | Dictionary of custom properties for the ticket. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Update ticket
Section titled “Update ticket”HUBSPOT_UPDATE_TICKET
Updates properties for an existing HubSpot ticket.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
ticketId | string | Yes | Unique HubSpot identifier for the ticket to be updated. |
properties | object | Yes | Ticket properties to update. Keys are internal HubSpot property names. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create note
Section titled “Create note”HUBSPOT_CREATE_NOTE
Creates a new HubSpot CRM note. Use when you need to add a timestamped note with optional attachments and associations to contacts, companies, deals, or tickets.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
hs_timestamp | string | Yes | Creation time of the note. Either an ISO 8601 UTC timestamp (e.g., 2021-11-12T15:48:22Z) or Unix milliseconds since epoch. |
hs_note_body | string | No | Text content of the note (up to 65,536 characters). |
hubspot_owner_id | string | No | HubSpot user ID to assign as the creator/owner of this note. |
associations | array | No | List of associations to link with the note (e.g., contacts, deals, companies). |
hs_attachment_ids | string | No | Semicolon-separated list of file attachment IDs. |
custom_properties | object | No | A dictionary of custom properties. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create task
Section titled “Create task”HUBSPOT_CREATE_TASK
Creates a new CRM task record. Use when adding a task with properties and optional associations.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
hs_timestamp | string | Yes | Task due date in ISO 8601 format or Unix milliseconds. |
hs_task_subject | string | No | Title or subject line of the task. |
hs_task_body | string | No | Notes or body text of the task. |
hs_task_type | string | No | Type of the task: CALL, EMAIL, or TODO. Defaults to TODO. |
hs_task_status | string | No | Current status of the task: NOT_STARTED or COMPLETED. Defaults to NOT_STARTED. |
hs_task_priority | string | No | Priority level: LOW, MEDIUM, HIGH, or NONE. |
hubspot_owner_id | string | No | ID of the HubSpot owner to assign this task to. Use HUBSPOT_RETRIEVE_OWNERS to obtain valid owner IDs. |
associations | array | No | Optional list of associations to link this task with existing CRM records. |
custom_properties | object | No | A dictionary of custom properties. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create line item
Section titled “Create line item”HUBSPOT_CREATE_LINE_ITEM
Creates a new HubSpot line item. Use to connect product information to a deal or quote via hs_product_id.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
properties | object | Yes | Line item properties to set. Keys are HubSpot internal property names. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create product
Section titled “Create product”HUBSPOT_CREATE_PRODUCT
Creates a new HubSpot product. Note: Products are catalog items and cannot be directly associated with deals, contacts, or companies. To connect product information to a deal or quote, create a line item using HUBSPOT_CREATE_LINE_ITEM that references this product’s ID via hs_product_id.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | The official name of the product. |
price | number | No | The selling price of the product in the default currency of the HubSpot account. |
hs_sku | string | No | The Stock Keeping Unit (SKU) for the product. |
description | string | No | A detailed description of the product, its features, and benefits. |
hs_url | string | No | A direct URL link to the product’s page on an e-commerce website. |
hs_active | boolean | No | Indicates if the product is currently active and available for sale. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
List products
Section titled “List products”HUBSPOT_LIST_PRODUCTS
Retrieves a paginated list of HubSpot catalog products.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
after | string | No | Pagination token from a previous response. |
limit | integer | No | Maximum number of products to return per page. |
archived | boolean | No | Filter by archived status. |
properties | array | No | List of product property names to include in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Retrieve owners
Section titled “Retrieve owners”HUBSPOT_RETRIEVE_OWNERS
Retrieves a list of all owners in the HubSpot CRM, including their ID, first name, last name, email, and user ID.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Retrieve all pipelines for specified object type
Section titled “Retrieve all pipelines for specified object type”HUBSPOT_RETRIEVE_ALL_PIPELINES_FOR_SPECIFIED_OBJECT_TYPE
Retrieves all pipelines in HubSpot for a specified CRM object type, such as deals or tickets.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
objectType | string | Yes | The case-sensitive CRM object type (e.g., deals, tickets) for which to retrieve pipelines. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Create object association
Section titled “Create object association”HUBSPOT_CREATE_OBJECT_ASSOCIATION
Creates or labels an association between two CRM records using HubSpot Associations v4 API. Use when you need to link records (e.g., contact to company, deal to contact) with explicit association labels.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
objectType | string | Yes | The type of the source object (e.g., contacts, companies, deals, tickets). |
objectId | string | Yes | The unique ID of the source CRM record. |
toObjectType | string | Yes | The type of the target object to associate with. |
toObjectId | string | Yes | The unique ID of the target CRM record to associate with. |
labels | array | Yes | Array of association label descriptors defining the type(s) of relationship. Each label includes associationCategory and associationTypeId. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |
Search CRM objects by criteria
Section titled “Search CRM objects by criteria”HUBSPOT_SEARCH_CRM_OBJECTS_BY_CRITERIA
Searches HubSpot CRM objects (e.g., contacts, companies) by objectType using complex criteria including filters, sorting, and pagination.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
objectType | string | Yes | The type of CRM object to search. Valid values: contacts, companies, deals, tickets, tasks, line_items, products, quotes, calls, emails, meetings, notes, or custom object IDs like 2-1234567. |
after | string | No | Cursor for pagination. HubSpot’s search API has a hard limit of 10,000 total results. |
limit | integer | No | Max results per page (default 10, max 100). |
query | string | No | A string for a broad search across multiple fields on the object. |
sorts | array | No | List of sort rules. Only one sorting rule can be applied to any search. |
properties | array | No | List of property names to include in the response. |
filterGroups | array | No | List of filter groups (AND within, OR between). Maximum of 5 groups with up to 6 filters each (18 total). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution |
error | string | No | Error if any occurred during the execution of the action |
successful | boolean | Yes | Whether or not the action execution was successful or not |