HubSpot stores CRM contacts, companies, deals, tickets, and related records. Use this integration to read and update those records and trigger workflows from HubSpot events. Follow the HubSpot setup guide to connect your account.
Integrate HubSpot into your workflow. Manage contacts, companies, deals, tickets, and other CRM objects with powerful automation capabilities. Log AI call outcomes, meetings, and follow-up tasks against contacts, companies, and deals. Can be used in trigger mode to start workflows when records are created, updated, a specific property changes, or a contact joins a list, either by polling or instantly through HubSpot webhooks.
Retrieve all users from HubSpot account
| Parameter | Type | Required | Description |
|---|
limit | string | No | Number of results to return (default: 10, max: 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot user property names to return (e.g., "hs_email,hs_given_name,hs_family_name") |
| Parameter | Type | Description |
|---|
users | array | Array of HubSpot CRM records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Record properties |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
totalItems | number | Total number of users returned |
success | boolean | Operation success status |
Retrieve all contacts from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals") |
| Parameter | Type | Description |
|---|
contacts | array | Array of HubSpot contact records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Contact properties |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single contact by ID or email from HubSpot
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | The HubSpot contact ID (numeric string) or email address to retrieve |
idProperty | string | No | Property to use as unique identifier (e.g., "email"). If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals") |
| Parameter | Type | Description |
|---|
contact | object | HubSpot contact record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Contact properties |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
↳ associations | object | Associated records (companies, deals, etc.) |
contactId | string | The retrieved contact ID |
success | boolean | Operation success status |
Create a new contact in HubSpot. Requires at least one of: email, firstname, or lastname
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Contact properties as JSON object. Must include at least one of: email, firstname, or lastname (e.g., {"email": "john@example.com", "firstname": "John", "lastname": "Doe"}) |
associations | array | No | Array of associations to create with the contact as JSON. Each object should have "to.id" (company/deal ID) and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
contact | object | HubSpot contact record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Contact properties |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
↳ associations | object | Associated records (companies, deals, etc.) |
contactId | string | The created contact ID |
success | boolean | Operation success status |
Update an existing contact in HubSpot by ID or email
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | The HubSpot contact ID (numeric string) or email of the contact to update |
idProperty | string | No | Property to use as unique identifier (e.g., "email"). If not specified, uses record ID |
properties | object | Yes | Contact properties to update as JSON object (e.g., {"firstname": "John", "phone": "+1234567890"}) |
| Parameter | Type | Description |
|---|
contact | object | HubSpot contact record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Contact properties |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
↳ associations | object | Associated records (companies, deals, etc.) |
contactId | string | The updated contact ID |
success | boolean | Operation success status |
Search for contacts in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against contact name, email, and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["email", "firstname", "lastname", "phone"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
contacts | array | Array of HubSpot contact records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Contact properties |
↳ email | string | Contact email address |
↳ firstname | string | Contact first name |
↳ lastname | string | Contact last name |
↳ phone | string | Contact phone number |
↳ mobilephone | string | Contact mobile phone number |
↳ company | string | Associated company name |
↳ website | string | Contact website URL |
↳ jobtitle | string | Contact job title |
↳ lifecyclestage | string | Lifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Contact creation date (ISO 8601) |
↳ lastmodifieddate | string | Last modified date (ISO 8601) |
↳ address | string | Street address |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ fax | string | Fax number |
↳ hs_timezone | string | Contact timezone |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching contacts |
success | boolean | Operation success status |
Retrieve all companies from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,domain,industry") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals") |
| Parameter | Type | Description |
|---|
companies | array | Array of HubSpot company records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Company properties |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single company by ID or domain from HubSpot
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | The HubSpot company ID (numeric string) or domain to retrieve |
idProperty | string | No | Property to use as unique identifier (e.g., "domain"). If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,domain,industry") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals") |
| Parameter | Type | Description |
|---|
company | object | HubSpot company record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Company properties |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
↳ associations | object | Associated records (contacts, deals, etc.) |
companyId | string | The retrieved company ID |
success | boolean | Operation success status |
Create a new company in HubSpot
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Company properties as JSON object (e.g., {"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"}) |
associations | array | No | Array of associations to create with the company as JSON (each with "to.id" and "types" containing "associationCategory" and "associationTypeId") |
| Parameter | Type | Description |
|---|
company | object | HubSpot company record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Company properties |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
↳ associations | object | Associated records (contacts, deals, etc.) |
companyId | string | The created company ID |
success | boolean | Operation success status |
Update an existing company in HubSpot by ID or domain
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | The HubSpot company ID (numeric string) or domain of the company to update |
idProperty | string | No | Property to use as unique identifier (e.g., "domain"). If not specified, uses record ID |
properties | object | Yes | Company properties to update as JSON object (e.g., {"name": "New Name", "industry": "Finance"}) |
| Parameter | Type | Description |
|---|
company | object | HubSpot company record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Company properties |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
↳ associations | object | Associated records (contacts, deals, etc.) |
companyId | string | The updated company ID |
success | boolean | Operation success status |
Search for companies in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against company name, domain, and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["name", "domain", "industry"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
companies | array | Array of HubSpot company records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Company properties |
↳ name | string | Company name |
↳ domain | string | Company website domain (unique identifier) |
↳ description | string | Company description |
↳ industry | string | Industry type (e.g., Airlines/Aviation) |
↳ phone | string | Company phone number |
↳ city | string | City |
↳ state | string | State/Region |
↳ zip | string | Postal/ZIP code |
↳ country | string | Country |
↳ address | string | Street address |
↳ numberofemployees | string | Total number of employees |
↳ annualrevenue | string | Annual revenue estimate |
↳ lifecyclestage | string | Lifecycle stage |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Company creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ hs_additional_domains | string | Additional domains (semicolon-separated) |
↳ num_associated_contacts | string | Number of associated contacts (auto-updated) |
↳ num_associated_deals | string | Number of associated deals (auto-updated) |
↳ website | string | Company website URL |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching companies |
success | boolean | Operation success status |
Retrieve all deals from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
deals | array | Array of HubSpot deal records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Deal properties |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single deal by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | The HubSpot deal ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
deal | object | HubSpot deal record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Deal properties |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
↳ associations | object | Associated records (contacts, companies, line items, etc.) |
dealId | string | The retrieved deal ID |
success | boolean | Operation success status |
Create a new deal in HubSpot with the given properties (e.g., dealname, amount, dealstage)
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Deal properties as JSON object. Should include dealname and dealstage, plus pipeline when the account has multiple pipelines (e.g., {"dealname": "New Deal", "amount": "5000", "dealstage": "appointmentscheduled"}) |
associations | array | No | Array of associations to create with the deal as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
deal | object | HubSpot deal record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Deal properties |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
↳ associations | object | Associated records (contacts, companies, line items, etc.) |
dealId | string | The created deal ID |
success | boolean | Operation success status |
Update an existing deal in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | The HubSpot deal ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Deal properties to update as JSON object (e.g., {"amount": "10000", "dealstage": "closedwon"}) |
| Parameter | Type | Description |
|---|
deal | object | HubSpot deal record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Deal properties |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
↳ associations | object | Associated records (contacts, companies, line items, etc.) |
dealId | string | The updated deal ID |
success | boolean | Operation success status |
Search for deals in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "NEQ", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against deal name and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["dealname", "amount", "dealstage"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
deals | array | Array of HubSpot deal records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Deal properties |
↳ dealname | string | Deal name |
↳ amount | string | Deal amount |
↳ dealstage | string | Current deal stage |
↳ pipeline | string | Pipeline the deal is in |
↳ closedate | string | Expected close date (ISO 8601) |
↳ dealtype | string | Deal type (New Business, Existing Business, etc.) |
↳ description | string | Deal description |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Deal creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ num_associated_contacts | string | Number of associated contacts |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching deals |
success | boolean | Operation success status |
Retrieve all tickets from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
tickets | array | Array of HubSpot ticket records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Ticket properties |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single ticket by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | The HubSpot ticket ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
ticket | object | HubSpot ticket record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Ticket properties |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, etc.) |
ticketId | string | The retrieved ticket ID |
success | boolean | Operation success status |
Create a new ticket in HubSpot. Requires subject and hs_pipeline_stage properties
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Ticket properties as JSON object. Must include subject and hs_pipeline_stage (e.g., {"subject": "Support request", "hs_pipeline_stage": "1", "hs_ticket_priority": "HIGH"}) |
associations | array | No | Array of associations to create with the ticket as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
ticket | object | HubSpot ticket record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Ticket properties |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, etc.) |
ticketId | string | The created ticket ID |
success | boolean | Operation success status |
Update an existing ticket in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | The HubSpot ticket ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Ticket properties to update as JSON object (e.g., {"subject": "Updated subject", "hs_ticket_priority": "HIGH"}) |
| Parameter | Type | Description |
|---|
ticket | object | HubSpot ticket record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Ticket properties |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, etc.) |
ticketId | string | The updated ticket ID |
success | boolean | Operation success status |
Search for tickets in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "NEQ", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against ticket subject and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["subject", "content", "hs_ticket_priority"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
tickets | array | Array of HubSpot ticket records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Ticket properties |
↳ subject | string | Ticket subject/name |
↳ content | string | Ticket content/description |
↳ hs_pipeline | string | Pipeline the ticket is in |
↳ hs_pipeline_stage | string | Current pipeline stage |
↳ hs_ticket_priority | string | Ticket priority (LOW, MEDIUM, HIGH) |
↳ hs_ticket_category | string | Ticket category |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Ticket creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching tickets |
success | boolean | Operation success status |
Retrieve all notes from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
notes | array | Array of HubSpot note records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Note properties |
↳ hs_note_body | string | Note text/body (supports rich text/HTML) |
↳ hs_timestamp | string | Note activity time (ISO 8601) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_attachment_ids | string | Semicolon-separated IDs of files attached to the note |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Note creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single note by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
noteId | string | Yes | The HubSpot note ID to retrieve |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
note | object | HubSpot note record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Note properties |
↳ hs_note_body | string | Note text/body (supports rich text/HTML) |
↳ hs_timestamp | string | Note activity time (ISO 8601) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_attachment_ids | string | Semicolon-separated IDs of files attached to the note |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Note creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, deals, etc.) |
noteId | string | The retrieved note ID |
success | boolean | Operation success status |
Log a note in HubSpot and optionally associate it with contacts, companies, or deals. Requires hs_timestamp and hs_note_body properties
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Note properties as JSON object. Must include "hs_timestamp" (ISO 8601 activity time) and "hs_note_body" (the note text). e.g., {"hs_timestamp": "2026-06-13T00:00:00Z", "hs_note_body": "Followed up via phone"} |
associations | array | No | Array of associations as JSON. Each object has "to.id" (record ID) and "types" array with "associationCategory" ("HUBSPOT_DEFINED") and "associationTypeId" (202 = note→contact, 190 = note→company, 214 = note→deal) |
| Parameter | Type | Description |
|---|
note | object | HubSpot note record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Note properties |
↳ hs_note_body | string | Note text/body (supports rich text/HTML) |
↳ hs_timestamp | string | Note activity time (ISO 8601) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_attachment_ids | string | Semicolon-separated IDs of files attached to the note |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Note creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, deals, etc.) |
noteId | string | The created note ID |
success | boolean | Operation success status |
Search for notes in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against note text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["hs_note_body", "hs_timestamp", "hubspot_owner_id"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
notes | array | Array of HubSpot note records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Note properties |
↳ hs_note_body | string | Note text/body (supports rich text/HTML) |
↳ hs_timestamp | string | Note activity time (ISO 8601) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_attachment_ids | string | Semicolon-separated IDs of files attached to the note |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Note creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching notes |
success | boolean | Operation success status |
Retrieve all email engagements from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
emails | array | Array of HubSpot email engagement records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Email properties |
↳ hs_timestamp | string | Email activity time (ISO 8601) |
↳ hs_email_direction | string | Direction (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL) |
↳ hs_email_status | string | Send status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED) |
↳ hs_email_subject | string | Email subject line |
↳ hs_email_text | string | Plain-text email body |
↳ hs_email_html | string | HTML email body |
↳ hs_email_headers | string | JSON-encoded from/to/cc/bcc headers |
↳ hs_email_from_email | string | Sender email address |
↳ hs_email_to_email | string | Recipient email address(es) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Email creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single email engagement by ID from HubSpot (content requires the sales-email-read scope)
| Parameter | Type | Required | Description |
|---|
emailId | string | Yes | The HubSpot email engagement ID to retrieve |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
email | object | HubSpot email engagement record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Email properties |
↳ hs_timestamp | string | Email activity time (ISO 8601) |
↳ hs_email_direction | string | Direction (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL) |
↳ hs_email_status | string | Send status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED) |
↳ hs_email_subject | string | Email subject line |
↳ hs_email_text | string | Plain-text email body |
↳ hs_email_html | string | HTML email body |
↳ hs_email_headers | string | JSON-encoded from/to/cc/bcc headers |
↳ hs_email_from_email | string | Sender email address |
↳ hs_email_to_email | string | Recipient email address(es) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Email creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, deals, etc.) |
emailId | string | The retrieved email engagement ID |
success | boolean | Operation success status |
Log an email engagement in HubSpot and optionally associate it with contacts. Requires the hs_timestamp property
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Email properties as JSON object. Must include "hs_timestamp" (ISO 8601). Common fields: "hs_email_direction" (EMAIL, INCOMING_EMAIL, FORWARDED_EMAIL), "hs_email_status" (SENT, SENDING, SCHEDULED, FAILED, BOUNCED), "hs_email_subject", "hs_email_text", "hs_email_html", "hs_email_headers" (JSON string) |
associations | array | No | Array of associations as JSON. Each object has "to.id" (record ID) and "types" array with "associationCategory" ("HUBSPOT_DEFINED") and "associationTypeId" (198 = email→contact) |
| Parameter | Type | Description |
|---|
email | object | HubSpot email engagement record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Email properties |
↳ hs_timestamp | string | Email activity time (ISO 8601) |
↳ hs_email_direction | string | Direction (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL) |
↳ hs_email_status | string | Send status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED) |
↳ hs_email_subject | string | Email subject line |
↳ hs_email_text | string | Plain-text email body |
↳ hs_email_html | string | HTML email body |
↳ hs_email_headers | string | JSON-encoded from/to/cc/bcc headers |
↳ hs_email_from_email | string | Sender email address |
↳ hs_email_to_email | string | Recipient email address(es) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Email creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, deals, etc.) |
emailId | string | The created email engagement ID |
success | boolean | Operation success status |
Search for email engagements in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against email text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["hs_email_subject", "hs_email_text", "hs_timestamp"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
emails | array | Array of HubSpot email engagement records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Email properties |
↳ hs_timestamp | string | Email activity time (ISO 8601) |
↳ hs_email_direction | string | Direction (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL) |
↳ hs_email_status | string | Send status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED) |
↳ hs_email_subject | string | Email subject line |
↳ hs_email_text | string | Plain-text email body |
↳ hs_email_html | string | HTML email body |
↳ hs_email_headers | string | JSON-encoded from/to/cc/bcc headers |
↳ hs_email_from_email | string | Sender email address |
↳ hs_email_to_email | string | Recipient email address(es) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Email creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching emails |
success | boolean | Operation success status |
Read property definitions and their enumeration (picklist) options for a HubSpot object type, e.g. the values for lifecyclestage or hs_lead_status on contacts
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | Object type to read properties for (e.g., "contacts", "companies", "deals", "tickets", "line_items", "quotes") |
propertyName | string | No | Internal name of a single property to retrieve (e.g., "hs_lead_status"). Omit to return all properties for the object type |
archived | boolean | No | Whether to return only archived properties (default false) |
| Parameter | Type | Description |
|---|
properties | array | Array of HubSpot property definitions |
↳ name | string | Internal property name |
↳ label | string | Human-readable label |
↳ type | string | Property data type (string, number, enumeration, bool, datetime, etc.) |
↳ fieldType | string | Field type controlling HubSpot UI rendering |
↳ description | string | Property help text |
↳ groupName | string | Property group the property belongs to |
↳ options | array | Enumeration/picklist options (empty for non-enumerated properties) |
↳ label | string | Human-readable option label |
↳ value | string | Internal value used when setting the property |
↳ displayOrder | number | Display order (-1 sorts last) |
↳ hidden | boolean | Whether the option is hidden in the HubSpot UI |
↳ description | string | Option description |
↳ displayOrder | number | Display order |
↳ calculated | boolean | Whether the property is calculated by HubSpot |
↳ hidden | boolean | Whether the property is hidden |
↳ hubspotDefined | boolean | Whether the property is a HubSpot default property |
↳ archived | boolean | Whether the property is archived |
metadata | object | Response metadata |
↳ totalReturned | number | Number of property definitions returned |
↳ objectType | string | Object type the properties belong to |
success | boolean | Operation success status |
List records of one object type associated with a given record, e.g. all emails or notes logged on a contact
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | Source object type (e.g., "contacts", "companies", "deals") |
objectId | string | Yes | ID of the source record |
toObjectType | string | Yes | Target object type to list associations to (e.g., "emails", "notes", "deals") |
limit | string | No | Maximum number of associated records per page (default 500) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
results | array | Array of associated records |
↳ toObjectId | string | ID of the associated (target) record |
↳ associationTypes | array | Association types linking the two records |
↳ category | string | Association category (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED) |
↳ typeId | number | Association type ID |
↳ label | string | Association label |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Associate two HubSpot records. Creates the default (unlabeled) association unless an association type ID is provided
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | Source object type (e.g., "emails", "notes", "contacts") |
objectId | string | Yes | ID of the source record |
toObjectType | string | Yes | Target object type to associate to (e.g., "contacts", "companies", "deals") |
toObjectId | string | Yes | ID of the target record |
associationCategory | string | No | Association category for a labeled association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED). Defaults to HUBSPOT_DEFINED when an association type ID is provided |
associationTypeId | number | No | Specific association type ID for a labeled association. Omit to create the default association for the object pair |
| Parameter | Type | Description |
|---|
fromObjectId | string | ID of the source record |
toObjectId | string | ID of the associated target record |
labels | array | Association labels (empty for default associations) |
success | boolean | Operation success status |
Remove all associations between two HubSpot records
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | The source object type (e.g., "contacts", "companies", "deals") |
objectId | string | Yes | The ID of the source record |
toObjectType | string | Yes | The target object type (e.g., "emails", "notes", "contacts") |
toObjectId | string | Yes | The ID of the target record |
| Parameter | Type | Description |
|---|
fromObjectId | string | Source record ID |
toObjectId | string | Target record ID |
deleted | boolean | Whether the associations were removed |
success | boolean | Operation success status |
Retrieve the association types (category, typeId, label) defined between two HubSpot object types
| Parameter | Type | Required | Description |
|---|
objectType | string | Yes | The source object type (e.g., "contacts", "companies", "deals") |
toObjectType | string | Yes | The target object type (e.g., "emails", "notes", "contacts") |
| Parameter | Type | Description |
|---|
labels | array | Association types defined between the two object types |
↳ category | string | Association category (HUBSPOT_DEFINED or USER_DEFINED) |
↳ typeId | number | Association type ID |
↳ label | string | Human-readable label (null for unlabeled defaults) |
success | boolean | Operation success status |
Archive a contact in HubSpot by ID (moves it to the recycling bin)
| Parameter | Type | Required | Description |
|---|
contactId | string | Yes | The numeric ID of the contact to delete |
| Parameter | Type | Description |
|---|
contactId | string | ID of the deleted contact |
deleted | boolean | Whether the contact was archived |
success | boolean | Operation success status |
Archive a company in HubSpot by ID (moves it to the recycling bin)
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | The numeric ID of the company to delete |
| Parameter | Type | Description |
|---|
companyId | string | ID of the deleted company |
deleted | boolean | Whether the company was archived |
success | boolean | Operation success status |
Archive a deal in HubSpot by ID (moves it to the recycling bin)
| Parameter | Type | Required | Description |
|---|
dealId | string | Yes | The numeric ID of the deal to delete |
| Parameter | Type | Description |
|---|
dealId | string | ID of the deleted deal |
deleted | boolean | Whether the deal was archived |
success | boolean | Operation success status |
Archive a ticket in HubSpot by ID (moves it to the recycling bin)
| Parameter | Type | Required | Description |
|---|
ticketId | string | Yes | The numeric ID of the ticket to delete |
| Parameter | Type | Description |
|---|
ticketId | string | ID of the deleted ticket |
deleted | boolean | Whether the ticket was archived |
success | boolean | Operation success status |
Archive a line item in HubSpot by ID (moves it to the recycling bin)
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | The numeric ID of the line item to delete |
| Parameter | Type | Description |
|---|
lineItemId | string | ID of the deleted line item |
deleted | boolean | Whether the line item was archived |
success | boolean | Operation success status |
Search for line items in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "NEQ", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against line item name and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["name", "quantity", "price"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
lineItems | array | Array of HubSpot line item records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Line item properties |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching line items |
success | boolean | Operation success status |
Search for quotes in HubSpot using filters, sorting, and queries
| Parameter | Type | Required | Description |
|---|
filterGroups | array | No | Array of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "NEQ", "CONTAINS_TOKEN", "NOT_CONTAINS_TOKEN"), and "value" |
sorts | array | No | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | No | Search query string to match against quote title and other text fields |
properties | array | No | Array of HubSpot property names to return (e.g., ["hs_title", "hs_expiration_date"]) |
limit | number | No | Maximum number of results to return (max 200, default 10) |
after | string | No | Pagination cursor for next page (from previous response) |
| Parameter | Type | Description |
|---|
quotes | array | Array of HubSpot quote records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Quote properties |
↳ hs_title | string | Quote name/title |
↳ hs_expiration_date | string | Expiration date |
↳ hs_status | string | Quote status |
↳ hs_esign_enabled | string | Whether e-signatures are enabled |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
total | number | Total number of matching quotes |
success | boolean | Operation success status |
Retrieve the record IDs that are members of a HubSpot list, ordered by record ID
| Parameter | Type | Required | Description |
|---|
listId | string | Yes | The ID of the list to read members from |
limit | string | No | Maximum number of results per page (max 250, default 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
| Parameter | Type | Description |
|---|
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
memberships | array | Records that are members of the list |
↳ recordId | string | ID of the member record |
↳ membershipTimestamp | string | When the record was added to the list |
success | boolean | Operation success status |
Add records to a manual (static) HubSpot list by record ID
| Parameter | Type | Required | Description |
|---|
listId | string | Yes | The ID of the list to add records to (MANUAL or SNAPSHOT lists only) |
recordIds | array | Yes | Record IDs to add to the list, as a JSON array (e.g., ["123","456"]) or comma-separated string |
| Parameter | Type | Description |
|---|
recordIdsAdded | array | IDs of the records that were added to the list |
recordIdsMissing | array | IDs of the requested records that were not found |
success | boolean | Operation success status |
Remove records from a manual (static) HubSpot list by record ID
| Parameter | Type | Required | Description |
|---|
listId | string | Yes | The ID of the list to remove records from (MANUAL or SNAPSHOT lists only) |
recordIds | array | Yes | Record IDs to remove from the list, as a JSON array (e.g., ["123","456"]) or comma-separated string |
| Parameter | Type | Description |
|---|
recordIdsRemoved | array | IDs of the records that were removed from the list |
recordIdsMissing | array | IDs of the requested records that were not found |
success | boolean | Operation success status |
Retrieve all line items from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes") |
| Parameter | Type | Description |
|---|
lineItems | array | Array of HubSpot line item records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Line item properties |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single line item by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | The HubSpot line item ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes") |
| Parameter | Type | Description |
|---|
lineItem | object | HubSpot line item record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Line item properties |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (deals, quotes, etc.) |
lineItemId | string | The retrieved line item ID |
success | boolean | Operation success status |
Create a new line item in HubSpot. Requires at least a name property
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Line item properties as JSON object (e.g., {"name": "Product A", "quantity": "2", "price": "50.00", "hs_sku": "SKU-001"}) |
associations | array | No | Array of associations to create with the line item as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
lineItem | object | HubSpot line item record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Line item properties |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (deals, quotes, etc.) |
lineItemId | string | The created line item ID |
success | boolean | Operation success status |
Update an existing line item in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
lineItemId | string | Yes | The HubSpot line item ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Line item properties to update as JSON object (e.g., {"quantity": "5", "price": "25.00"}) |
| Parameter | Type | Description |
|---|
lineItem | object | HubSpot line item record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Line item properties |
↳ name | string | Line item name |
↳ description | string | Full description of the product |
↳ hs_sku | string | Unique product identifier (SKU) |
↳ quantity | string | Number of units included |
↳ price | string | Unit price |
↳ amount | string | Total cost (quantity * unit price) |
↳ hs_line_item_currency_code | string | Currency code |
↳ recurringbillingfrequency | string | Recurring billing frequency |
↳ hs_recurring_billing_start_date | string | Recurring billing start date |
↳ hs_recurring_billing_end_date | string | Recurring billing end date |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (deals, quotes, etc.) |
lineItemId | string | The updated line item ID |
success | boolean | Operation success status |
Retrieve all quotes from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items") |
| Parameter | Type | Description |
|---|
quotes | array | Array of HubSpot quote records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Quote properties |
↳ hs_title | string | Quote name/title |
↳ hs_expiration_date | string | Expiration date |
↳ hs_status | string | Quote status |
↳ hs_esign_enabled | string | Whether e-signatures are enabled |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single quote by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
quoteId | string | Yes | The HubSpot quote ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items") |
| Parameter | Type | Description |
|---|
quote | object | HubSpot quote record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Quote properties |
↳ hs_title | string | Quote name/title |
↳ hs_expiration_date | string | Expiration date |
↳ hs_status | string | Quote status |
↳ hs_esign_enabled | string | Whether e-signatures are enabled |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (deals, line items, etc.) |
quoteId | string | The retrieved quote ID |
success | boolean | Operation success status |
Retrieve all appointments from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_appointment_name,hs_appointment_start") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
appointments | array | Array of HubSpot appointment records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Appointment properties |
↳ hs_appointment_name | string | Appointment title/name |
↳ hs_appointment_start | string | Start time (ISO 8601) |
↳ hs_appointment_end | string | End time (ISO 8601) |
↳ hs_appointment_status | string | Appointment status (e.g., SCHEDULED) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single appointment by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
appointmentId | string | Yes | The HubSpot appointment ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_appointment_name,hs_appointment_start") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| Parameter | Type | Description |
|---|
appointment | object | HubSpot appointment record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Appointment properties |
↳ hs_appointment_name | string | Appointment title/name |
↳ hs_appointment_start | string | Start time (ISO 8601) |
↳ hs_appointment_end | string | End time (ISO 8601) |
↳ hs_appointment_status | string | Appointment status (e.g., SCHEDULED) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, etc.) |
appointmentId | string | The retrieved appointment ID |
success | boolean | Operation success status |
Create a new appointment in HubSpot
| Parameter | Type | Required | Description |
|---|
properties | object | Yes | Appointment properties as JSON object. Must include hs_appointment_start (e.g., {"hs_appointment_name": "Discovery Call", "hs_appointment_start": "2024-01-15T10:00:00Z", "hs_appointment_end": "2024-01-15T11:00:00Z"}) |
associations | array | No | Array of associations to create with the appointment as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
appointment | object | HubSpot appointment record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Appointment properties |
↳ hs_appointment_name | string | Appointment title/name |
↳ hs_appointment_start | string | Start time (ISO 8601) |
↳ hs_appointment_end | string | End time (ISO 8601) |
↳ hs_appointment_status | string | Appointment status (e.g., SCHEDULED) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, etc.) |
appointmentId | string | The created appointment ID |
success | boolean | Operation success status |
Update an existing appointment in HubSpot by ID
| Parameter | Type | Required | Description |
|---|
appointmentId | string | Yes | The HubSpot appointment ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | object | Yes | Appointment properties to update as JSON object (e.g., {"hs_appointment_name": "Updated Call", "hs_appointment_start": "2024-01-15T10:00:00Z"}) |
| Parameter | Type | Description |
|---|
appointment | object | HubSpot appointment record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Appointment properties |
↳ hs_appointment_name | string | Appointment title/name |
↳ hs_appointment_start | string | Start time (ISO 8601) |
↳ hs_appointment_end | string | End time (ISO 8601) |
↳ hs_appointment_status | string | Appointment status (e.g., SCHEDULED) |
↳ hubspot_owner_id | string | HubSpot owner ID |
↳ hs_object_id | string | HubSpot object ID (same as record ID) |
↳ hs_createdate | string | Creation date (ISO 8601) |
↳ hs_lastmodifieddate | string | Last modified date (ISO 8601) |
↳ associations | object | Associated records (contacts, companies, etc.) |
appointmentId | string | The updated appointment ID |
success | boolean | Operation success status |
Retrieve logged calls from HubSpot with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_call_title,hs_call_disposition,hs_call_status") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single logged call by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
callId | string | Yes | The HubSpot call ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_call_title,hs_call_disposition,hs_call_status") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
callId | string | The retrieved call ID |
success | boolean | Operation success status |
Log a call engagement in HubSpot (title, notes, duration, direction, outcome, status, recording, phone numbers) and associate it with contacts, companies, or deals. hs_timestamp defaults to now
| Parameter | Type | Required | Description |
|---|
properties | object | No | Additional HubSpot properties as a JSON object. Structured fields on this tool override matching keys |
hubspotOwnerId | string | No | HubSpot owner ID (hubspot_owner_id) shown as the activity creator or assignee |
activityTimestamp | string | No | When the call happened (ISO 8601 or Unix milliseconds). Maps to hs_timestamp; defaults to the current time |
callTitle | string | No | Call title (hs_call_title) |
callBody | string | No | Call description, notes, or AI summary (hs_call_body) |
callDurationMs | string | No | Call duration in milliseconds (hs_call_duration) |
callDirection | string | No | Call direction from the HubSpot user perspective: INBOUND or OUTBOUND |
callDisposition | string | No | Call outcome GUID (hs_call_disposition). Defaults: Busy 9d9162e7-6cf3-4944-bf63-4dff82258764, Connected f240bbac-87c9-4f6e-bf70-924b57d47db7, Left live message a4c4c377-d246-4b32-a13b-75a56a4cd0ff, Left voicemail b2cf5968-551e-4856-9783-52b3da59a7d0, No answer 73a0d17f-1163-4015-bdd5-ec830791da20, Wrong number 17b47fee-58de-441e-a44c-c6300d46f273 |
callStatus | string | No | Call status (hs_call_status): BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, IN_PROGRESS, NO_ANSWER, QUEUED, or RINGING |
callRecordingUrl | string | No | HTTPS URL of the call recording, e.g. an .mp3 or .wav file (hs_call_recording_url) |
callToNumber | string | No | Phone number that received the call (hs_call_to_number) |
callFromNumber | string | No | Phone number the call was made from (hs_call_from_number) |
contactIds | string | No | Contact IDs to associate (comma-separated or JSON array). Uses the default association type 194 |
companyIds | string | No | Company IDs to associate (comma-separated or JSON array). Uses the default association type 182 |
dealIds | string | No | Deal IDs to associate (comma-separated or JSON array). Uses the default association type 206 |
associations | array | No | Additional raw associations as a JSON array. Each object has "to.id" and a "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
callId | string | The created call ID |
success | boolean | Operation success status |
Update a logged call in HubSpot by ID, for example to set its outcome, status, notes, or recording URL
| Parameter | Type | Required | Description |
|---|
properties | object | No | Additional HubSpot properties as a JSON object. Structured fields on this tool override matching keys |
hubspotOwnerId | string | No | HubSpot owner ID (hubspot_owner_id) shown as the activity creator or assignee |
activityTimestamp | string | No | When the call happened (ISO 8601 or Unix milliseconds). Maps to hs_timestamp |
callId | string | Yes | The HubSpot call ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
callTitle | string | No | Call title (hs_call_title) |
callBody | string | No | Call description, notes, or AI summary (hs_call_body) |
callDurationMs | string | No | Call duration in milliseconds (hs_call_duration) |
callDirection | string | No | Call direction from the HubSpot user perspective: INBOUND or OUTBOUND |
callDisposition | string | No | Call outcome GUID (hs_call_disposition). Defaults: Busy 9d9162e7-6cf3-4944-bf63-4dff82258764, Connected f240bbac-87c9-4f6e-bf70-924b57d47db7, Left live message a4c4c377-d246-4b32-a13b-75a56a4cd0ff, Left voicemail b2cf5968-551e-4856-9783-52b3da59a7d0, No answer 73a0d17f-1163-4015-bdd5-ec830791da20, Wrong number 17b47fee-58de-441e-a44c-c6300d46f273 |
callStatus | string | No | Call status (hs_call_status): BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, IN_PROGRESS, NO_ANSWER, QUEUED, or RINGING |
callRecordingUrl | string | No | HTTPS URL of the call recording, e.g. an .mp3 or .wav file (hs_call_recording_url) |
callToNumber | string | No | Phone number that received the call (hs_call_to_number) |
callFromNumber | string | No | Phone number the call was made from (hs_call_from_number) |
| Parameter | Type | Description |
|---|
callId | string | The updated call ID |
success | boolean | Operation success status |
List the call outcomes (dispositions) available in the HubSpot account, including custom outcomes. Use the id as hs_call_disposition when logging a call
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
dispositions | array | Call outcomes available in the account |
↳ id | string | Disposition GUID used as hs_call_disposition |
↳ label | string | Outcome label shown in HubSpot |
success | boolean | Operation success status |
Retrieve meetings from HubSpot with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_meeting_title,hs_meeting_start_time,hs_meeting_outcome") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single meeting by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
meetingId | string | Yes | The HubSpot meeting ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_meeting_title,hs_meeting_start_time,hs_meeting_outcome") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
meetingId | string | The retrieved meeting ID |
success | boolean | Operation success status |
Log a meeting engagement in HubSpot (title, description, start and end time, outcome, location) and associate it with contacts, companies, or deals. hs_timestamp defaults to the meeting start time
| Parameter | Type | Required | Description |
|---|
properties | object | No | Additional HubSpot properties as a JSON object. Structured fields on this tool override matching keys |
hubspotOwnerId | string | No | HubSpot owner ID (hubspot_owner_id) shown as the activity creator or assignee |
activityTimestamp | string | No | When the meeting occurred (ISO 8601 or Unix milliseconds). Maps to hs_timestamp; HubSpot defaults it to the meeting start time |
meetingTitle | string | No | Meeting title (hs_meeting_title) |
meetingBody | string | No | Meeting description (hs_meeting_body) |
meetingStartTime | string | No | Meeting start time, ISO 8601 or Unix milliseconds (hs_meeting_start_time) |
meetingEndTime | string | No | Meeting end time, ISO 8601 or Unix milliseconds (hs_meeting_end_time) |
meetingOutcome | string | No | Meeting outcome (hs_meeting_outcome): SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, or CANCELED |
meetingLocation | string | No | Address, room, video link, or phone number (hs_meeting_location) |
contactIds | string | No | Contact IDs to associate (comma-separated or JSON array). Uses the default association type 200 |
companyIds | string | No | Company IDs to associate (comma-separated or JSON array). Uses the default association type 188 |
dealIds | string | No | Deal IDs to associate (comma-separated or JSON array). Uses the default association type 212 |
associations | array | No | Additional raw associations as a JSON array. Each object has "to.id" and a "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
meetingId | string | The created meeting ID |
success | boolean | Operation success status |
Update a meeting in HubSpot by ID, for example to set its outcome after it happens
| Parameter | Type | Required | Description |
|---|
properties | object | No | Additional HubSpot properties as a JSON object. Structured fields on this tool override matching keys |
hubspotOwnerId | string | No | HubSpot owner ID (hubspot_owner_id) shown as the activity creator or assignee |
activityTimestamp | string | No | When the meeting occurred (ISO 8601 or Unix milliseconds). Maps to hs_timestamp |
meetingId | string | Yes | The HubSpot meeting ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
meetingTitle | string | No | Meeting title (hs_meeting_title) |
meetingBody | string | No | Meeting description (hs_meeting_body) |
meetingStartTime | string | No | Meeting start time, ISO 8601 or Unix milliseconds (hs_meeting_start_time) |
meetingEndTime | string | No | Meeting end time, ISO 8601 or Unix milliseconds (hs_meeting_end_time) |
meetingOutcome | string | No | Meeting outcome (hs_meeting_outcome): SCHEDULED, COMPLETED, RESCHEDULED, NO_SHOW, or CANCELED |
meetingLocation | string | No | Address, room, video link, or phone number (hs_meeting_location) |
| Parameter | Type | Description |
|---|
meetingId | string | The updated meeting ID |
success | boolean | Operation success status |
Retrieve tasks from HubSpot with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_task_subject,hs_task_status,hs_timestamp") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single task by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
taskId | string | Yes | The HubSpot task ID to retrieve |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
properties | string | No | Comma-separated list of HubSpot property names to return (e.g., "hs_task_subject,hs_task_status,hs_timestamp") |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| Parameter | Type | Description |
|---|
taskId | string | The retrieved task ID |
success | boolean | Operation success status |
Create a task in HubSpot (subject, notes, due date, status, priority, type, assignee) and associate it with contacts, companies, or deals. A due date (hs_timestamp) is required
| Parameter | Type | Required | Description |
|---|
properties | object | No | Additional HubSpot properties as a JSON object. Structured fields on this tool override matching keys |
hubspotOwnerId | string | No | HubSpot owner ID (hubspot_owner_id) shown as the activity creator or assignee |
activityTimestamp | string | No | Task due date (ISO 8601 or Unix milliseconds). Maps to hs_timestamp; required by HubSpot |
taskSubject | string | No | Task title (hs_task_subject) |
taskBody | string | No | Task notes (hs_task_body) |
taskStatus | string | No | Task status (hs_task_status): NOT_STARTED or COMPLETED |
taskPriority | string | No | Task priority (hs_task_priority): LOW, MEDIUM, or HIGH |
taskType | string | No | Task type (hs_task_type): EMAIL, CALL, or TODO |
contactIds | string | No | Contact IDs to associate (comma-separated or JSON array). Uses the default association type 204 |
companyIds | string | No | Company IDs to associate (comma-separated or JSON array). Uses the default association type 192 |
dealIds | string | No | Deal IDs to associate (comma-separated or JSON array). Uses the default association type 216 |
associations | array | No | Additional raw associations as a JSON array. Each object has "to.id" and a "types" array with "associationCategory" and "associationTypeId" |
| Parameter | Type | Description |
|---|
taskId | string | The created task ID |
success | boolean | Operation success status |
Update a task in HubSpot by ID, for example to complete it or change its due date
| Parameter | Type | Required | Description |
|---|
properties | object | No | Additional HubSpot properties as a JSON object. Structured fields on this tool override matching keys |
hubspotOwnerId | string | No | HubSpot owner ID (hubspot_owner_id) shown as the activity creator or assignee |
activityTimestamp | string | No | Task due date (ISO 8601 or Unix milliseconds). Maps to hs_timestamp |
taskId | string | Yes | The HubSpot task ID to update |
idProperty | string | No | Property to use as unique identifier. If not specified, uses record ID |
taskSubject | string | No | Task title (hs_task_subject) |
taskBody | string | No | Task notes (hs_task_body) |
taskStatus | string | No | Task status (hs_task_status): NOT_STARTED or COMPLETED |
taskPriority | string | No | Task priority (hs_task_priority): LOW, MEDIUM, or HIGH |
taskType | string | No | Task type (hs_task_type): EMAIL, CALL, or TODO |
| Parameter | Type | Description |
|---|
taskId | string | The updated task ID |
success | boolean | Operation success status |
Retrieve all carts from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
properties | string | No | Comma-separated list of HubSpot property names to return |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for |
| Parameter | Type | Description |
|---|
carts | array | Array of HubSpot CRM records |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Record properties |
↳ associations | object | Associated records |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single cart by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
cartId | string | Yes | The HubSpot cart ID to retrieve |
properties | string | No | Comma-separated list of HubSpot property names to return |
associations | string | No | Comma-separated list of object types to retrieve associated IDs for |
| Parameter | Type | Description |
|---|
cart | object | HubSpot CRM record |
↳ id | string | Unique record ID (hs_object_id) |
↳ createdAt | string | Record creation timestamp (ISO 8601) |
↳ updatedAt | string | Record last updated timestamp (ISO 8601) |
↳ archived | boolean | Whether the record is archived |
↳ properties | object | Record properties |
↳ associations | object | Associated records |
cartId | string | The retrieved cart ID |
success | boolean | Operation success status |
Retrieve all owners from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 100) |
after | string | No | Pagination cursor for next page of results (from previous response) |
email | string | No | Filter owners by email address |
| Parameter | Type | Description |
|---|
owners | array | Array of HubSpot owner objects |
↳ id | string | Owner ID |
↳ email | string | Owner email address |
↳ firstName | string | Owner first name |
↳ lastName | string | Owner last name |
↳ userId | number | Associated user ID |
↳ teams | array | Teams the owner belongs to |
↳ id | string | Team ID |
↳ name | string | Team name |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
↳ archived | boolean | Whether the owner is archived |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve all marketing events from HubSpot account with pagination support
| Parameter | Type | Required | Description |
|---|
limit | string | No | Maximum number of results per page (max 100, default 10) |
after | string | No | Pagination cursor for next page of results (from previous response) |
| Parameter | Type | Description |
|---|
events | array | Array of HubSpot marketing event objects |
↳ objectId | string | Unique event ID (HubSpot internal) |
↳ eventName | string | Event name |
↳ eventType | string | Event type |
↳ eventStatus | string | Event status |
↳ eventDescription | string | Event description |
↳ eventUrl | string | Event URL |
↳ eventOrganizer | string | Event organizer |
↳ startDateTime | string | Start date/time (ISO 8601) |
↳ endDateTime | string | End date/time (ISO 8601) |
↳ eventCancelled | boolean | Whether event is cancelled |
↳ eventCompleted | boolean | Whether event is completed |
↳ registrants | number | Number of registrants |
↳ attendees | number | Number of attendees |
↳ cancellations | number | Number of cancellations |
↳ noShows | number | Number of no-shows |
↳ externalEventId | string | External event ID |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
success | boolean | Operation success status |
Retrieve a single marketing event by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
eventId | string | Yes | The HubSpot marketing event objectId to retrieve |
| Parameter | Type | Description |
|---|
event | object | HubSpot marketing event |
↳ objectId | string | Unique event ID (HubSpot internal) |
↳ eventName | string | Event name |
↳ eventType | string | Event type |
↳ eventStatus | string | Event status |
↳ eventDescription | string | Event description |
↳ eventUrl | string | Event URL |
↳ eventOrganizer | string | Event organizer |
↳ startDateTime | string | Start date/time (ISO 8601) |
↳ endDateTime | string | End date/time (ISO 8601) |
↳ eventCancelled | boolean | Whether event is cancelled |
↳ eventCompleted | boolean | Whether event is completed |
↳ registrants | number | Number of registrants |
↳ attendees | number | Number of attendees |
↳ cancellations | number | Number of cancellations |
↳ noShows | number | Number of no-shows |
↳ externalEventId | string | External event ID |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
eventId | string | The retrieved marketing event ID |
success | boolean | Operation success status |
Search and retrieve lists from HubSpot account
| Parameter | Type | Required | Description |
|---|
query | string | No | Search query to filter lists by name. Leave empty to return all lists. |
count | string | No | Maximum number of results to return (default 20, max 500) |
offset | string | No | Pagination offset for next page of results (use the offset value from previous response) |
| Parameter | Type | Description |
|---|
lists | array | Array of HubSpot list objects |
↳ listId | string | List ID |
↳ name | string | List name |
↳ objectTypeId | string | Object type ID (e.g., 0-1 for contacts) |
↳ processingType | string | Processing type (MANUAL, DYNAMIC, SNAPSHOT) |
↳ processingStatus | string | Processing status (COMPLETE, PROCESSING) |
↳ listVersion | number | List version number |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
paging | object | Pagination information for fetching more results |
↳ next | object | Next page cursor information |
↳ after | string | Cursor for next page of results |
↳ link | string | Link to next page |
metadata | object | Response metadata |
↳ totalReturned | number | Number of records returned in this response |
↳ hasMore | boolean | Whether more records are available |
↳ total | number | Total number of lists matching the query |
success | boolean | Operation success status |
Retrieve a single list by ID from HubSpot
| Parameter | Type | Required | Description |
|---|
listId | string | Yes | The HubSpot list ID to retrieve |
| Parameter | Type | Description |
|---|
list | object | HubSpot list |
↳ listId | string | List ID |
↳ name | string | List name |
↳ objectTypeId | string | Object type ID (e.g., 0-1 for contacts) |
↳ processingType | string | Processing type (MANUAL, DYNAMIC, SNAPSHOT) |
↳ processingStatus | string | Processing status (COMPLETE, PROCESSING) |
↳ listVersion | number | List version number |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
listId | string | The retrieved list ID |
success | boolean | Operation success status |
Create a new list in HubSpot. Specify the object type and processing type (MANUAL or DYNAMIC)
| Parameter | Type | Required | Description |
|---|
name | string | Yes | Name of the list |
objectTypeId | string | Yes | Object type ID (e.g., "0-1" for contacts, "0-2" for companies) |
processingType | string | Yes | Processing type: "MANUAL" for static lists or "DYNAMIC" for active lists |
| Parameter | Type | Description |
|---|
list | object | HubSpot list |
↳ listId | string | List ID |
↳ name | string | List name |
↳ objectTypeId | string | Object type ID (e.g., 0-1 for contacts) |
↳ processingType | string | Processing type (MANUAL, DYNAMIC, SNAPSHOT) |
↳ processingStatus | string | Processing status (COMPLETE, PROCESSING) |
↳ listVersion | number | List version number |
↳ createdAt | string | Creation date (ISO 8601) |
↳ updatedAt | string | Last updated date (ISO 8601) |
listId | string | The created list ID |
success | boolean | Operation success status |
A Trigger is a block that starts a workflow when an event happens in this service.
Some of these are polling-based (checked on a schedule) while others are push-based webhooks.
Triggers when HubSpot CRM records (contacts, companies, deals, tickets, custom objects) are created or updated, or when contacts join a list
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | Connect a HubSpot account so Agent Serve can poll your CRM on your behalf. |
objectType | string | Yes | What you want to watch. |
customObjectTypeId | string | No | HubSpot custom object type ID (e.g. "2-12345"). Find it in HubSpot Settings → Objects → Custom Objects. |
listId | string | No | The HubSpot list to watch for new members. |
eventType | string | No | Created fires once per new record. Updated fires on any modification. Property Changed fires only when the chosen property changes value. |
targetPropertyName | string | No | Fires only when this specific property changes value on a record. |
properties | string | No | Properties to include on each record. Leave empty to use sensible defaults. Agent Serve always includes the timestamps it needs internally. |
pipelineId | string | No | Restrict to a single pipeline. |
stageId | string | No | Restrict to a single stage within the selected pipeline. |
ownerId | string | No | Restrict to records owned by a specific HubSpot user. |
filters | string | No | JSON array of HubSpot search filters, AND-combined. Each item: {"propertyName":"...","operator":"EQ","value":"..."}. Operators: EQ, NEQ, CONTAINS_TOKEN, NOT_CONTAINS_TOKEN, GT, GTE, LT, LTE, BETWEEN, IN, NOT_IN, HAS_PROPERTY, NOT_HAS_PROPERTY. |
maxRecordsPerPoll | string | No | Soft cap on records emitted per poll (default 50, max 1000). Excess rolls over to the next poll. |
| Parameter | Type | Description |
|---|
objectType | string | HubSpot object type (contact, company, deal, ticket, custom object id, or list_membership) |
eventType | string | Event type (created, updated, property_changed, or joined) |
objectId | string | HubSpot ID of the affected record (or contact id for list memberships) |
occurredAt | string | ISO timestamp of when the change happened in HubSpot |
properties | json | HubSpot properties on the record as a key-value object (property internal name → value). Default keys per object type (override via "Properties to Fetch"): Contact → firstname, lastname, email, phone, company, lifecyclestage, hs_lead_status, hubspot_owner_id, createdate, lastmodifieddate. Company → name, domain, industry, lifecyclestage, hubspot_owner_id, createdate, hs_lastmodifieddate. Deal → dealname, amount, dealstage, pipeline, closedate, hubspot_owner_id, createdate, hs_lastmodifieddate. Ticket → subject, content, hs_pipeline, hs_pipeline_stage, hs_ticket_priority, hubspot_owner_id, createdate, hs_lastmodifieddate. Custom and user-requested properties appear keyed by their HubSpot internal name. |
createdAt | string | ISO timestamp when the record was created in HubSpot |
updatedAt | string | ISO timestamp when the record was last updated in HubSpot |
archived | boolean | Whether the record is archived |
propertyName | string | Name of the property that changed (property_changed events only) |
propertyValue | string | New value of the changed property (property_changed events only) |
previousValue | string | Previous value before the change (property_changed events only) |
listId | string | HubSpot list ID (list_membership events only) |
timestamp | string | ISO timestamp when Agent Serve emitted the event |
Triggers instantly when HubSpot sends a webhook event (record created, property changed, deleted, merged, restored, or associations changed), including calls, meetings, and tasks
| Parameter | Type | Required | Description |
|---|
triggerCredentials | string | Yes | The HubSpot account whose events should start this workflow. |
webhookObjectTypes | string | No | Only run for these record types. Leave empty for all. |
webhookEventTypes | string | No | Only run for these events. Leave empty for all. |
webhookPropertyNames | string | No | For property change events, only run when one of these properties changed (comma-separated internal names). |
| Parameter | Type | Description |
|---|
eventId | string | Event ID (not guaranteed to be unique) |
subscriptionId | string | Subscription that produced the event |
subscriptionType | string | Subscription type, e.g. contact.creation or object.propertyChange |
objectType | string | Record type, e.g. contact, deal, call, meeting, or task |
action | string | Event action, e.g. creation, propertyChange, deletion, or associationChange |
objectTypeId | string | CRM object type ID for generic object.* events (e.g. 0-48 for calls) |
objectId | string | ID of the record that changed |
portalId | string | HubSpot account ID where the event occurred |
appId | string | HubSpot app ID that received the event |
occurredAt | number | When the event occurred (Unix milliseconds) |
attemptNumber | number | Delivery attempt, starting at 0 |
changeSource | string | Source of the change, e.g. CRM or IMPORT |
sourceId | string | User or source that triggered the event |
propertyName | string | Changed property (property change events) |
propertyValue | string | New property value (property change events) |
primaryObjectId | string | Merge winner record ID (merge events) |
mergedObjectIds | json | Record IDs merged into the winner |
newObjectId | string | Record created by the merge, if any |
numberOfPropertiesMoved | number | Properties transferred during the merge |
associationType | string | Classic association type, e.g. CONTACT_TO_COMPANY |
associationTypeId | string | Association type ID (generic events) |
associationCategory | string | HUBSPOT_DEFINED or USER_DEFINED (generic events) |
fromObjectId | string | Association source record ID |
toObjectId | string | Association target record ID |
fromObjectTypeId | string | Association source object type |
toObjectTypeId | string | Association target object type |
associationRemoved | boolean | True when the association was removed, false when added |
isPrimaryAssociation | boolean | Whether the target is the primary association |
messageId | string | New message ID (conversation.newMessage) |
messageType | string | MESSAGE or COMMENT (conversation.newMessage) |
payload | json | The raw HubSpot event |