Integrate HubSpot into your workflow. Manage contacts, companies, deals, tickets, and other CRM objects with powerful automation capabilities. Can be used in trigger mode to start workflows when contacts are created, deleted, or updated.
Retrieve users from HubSpot account via the CRM users object
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_email,hs_given_name,hs_family_name") |
| 参数 | 类型 | 描述 |
|---|
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 |
↳ 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 contacts from HubSpot account with pagination support
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 100) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals") |
| 参数 | 类型 | 描述 |
|---|
contacts | array | Array of HubSpot contact records |
↳ 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 |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
contactId | string | 是 | The HubSpot contact ID (numeric string) or email address to retrieve |
idProperty | string | 否 | Property to use as unique identifier (e.g., "email"). If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals") |
| 参数 | 类型 | 描述 |
|---|
contact | object | HubSpot contact record |
↳ 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 |
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
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | 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 | 否 | 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" |
| 参数 | 类型 | 描述 |
|---|
contact | object | HubSpot contact record |
↳ 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 |
contactId | string | The created contact ID |
success | boolean | Operation success status |
Update an existing contact in HubSpot by ID or email
| 参数 | 类型 | 必填 | 描述 |
|---|
contactId | string | 是 | The HubSpot contact ID (numeric string) or email of the contact to update |
idProperty | string | 否 | Property to use as unique identifier (e.g., "email"). If not specified, uses record ID |
properties | object | 是 | Contact properties to update as JSON object (e.g., {"firstname": "John", "phone": "+1234567890"}) |
| 参数 | 类型 | 描述 |
|---|
contact | object | HubSpot contact record |
↳ 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 |
contactId | string | The updated contact ID |
success | boolean | Operation success status |
Search for contacts in HubSpot using filters, sorting, and queries
| 参数 | 类型 | 必填 | 描述 |
|---|
filterGroups | array | 否 | 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 | 否 | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | 否 | Search query string to match against contact name, email, and other text fields |
properties | array | 否 | Array of HubSpot property names to return (e.g., ["email", "firstname", "lastname", "phone"]) |
limit | number | 否 | Maximum number of results to return (max 100) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
contacts | array | Array of HubSpot contact records |
↳ 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 |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 100) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "name,domain,industry") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals") |
| 参数 | 类型 | 描述 |
|---|
companies | array | Array of HubSpot company records |
↳ 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 |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
companyId | string | 是 | The HubSpot company ID (numeric string) or domain to retrieve |
idProperty | string | 否 | Property to use as unique identifier (e.g., "domain"). If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "name,domain,industry") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals") |
| 参数 | 类型 | 描述 |
|---|
company | object | HubSpot company record |
↳ 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 |
companyId | string | The retrieved company ID |
success | boolean | Operation success status |
Create a new company in HubSpot
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | Company properties as JSON object (e.g., {"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"}) |
associations | array | 否 | Array of associations to create with the company as JSON (each with "to.id" and "types" containing "associationCategory" and "associationTypeId") |
| 参数 | 类型 | 描述 |
|---|
company | object | HubSpot company record |
↳ 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 |
companyId | string | The created company ID |
success | boolean | Operation success status |
Update an existing company in HubSpot by ID or domain
| 参数 | 类型 | 必填 | 描述 |
|---|
companyId | string | 是 | The HubSpot company ID (numeric string) or domain of the company to update |
idProperty | string | 否 | Property to use as unique identifier (e.g., "domain"). If not specified, uses record ID |
properties | object | 是 | Company properties to update as JSON object (e.g., {"name": "New Name", "industry": "Finance"}) |
| 参数 | 类型 | 描述 |
|---|
company | object | HubSpot company record |
↳ 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 |
companyId | string | The updated company ID |
success | boolean | Operation success status |
Search for companies in HubSpot using filters, sorting, and queries
| 参数 | 类型 | 必填 | 描述 |
|---|
filterGroups | array | 否 | 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 | 否 | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | 否 | Search query string to match against company name, domain, and other text fields |
properties | array | 否 | Array of HubSpot property names to return (e.g., ["name", "domain", "industry"]) |
limit | number | 否 | Maximum number of results to return (max 100) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
companies | array | Array of HubSpot company records |
↳ 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 |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| 参数 | 类型 | 描述 |
|---|
deals | array | Array of HubSpot deal records |
↳ 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 |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
dealId | string | 是 | The HubSpot deal ID to retrieve |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| 参数 | 类型 | 描述 |
|---|
deal | object | HubSpot deal record |
↳ 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 |
dealId | string | The retrieved deal ID |
success | boolean | Operation success status |
Create a new deal in HubSpot. Requires at least a dealname property
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | Deal properties as JSON object. Must include dealname (e.g., {"dealname": "New Deal", "amount": "5000", "dealstage": "appointmentscheduled"}) |
associations | array | 否 | Array of associations to create with the deal as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| 参数 | 类型 | 描述 |
|---|
deal | object | HubSpot deal record |
↳ 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 |
dealId | string | The created deal ID |
success | boolean | Operation success status |
Update an existing deal in HubSpot by ID
| 参数 | 类型 | 必填 | 描述 |
|---|
dealId | string | 是 | The HubSpot deal ID to update |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | object | 是 | Deal properties to update as JSON object (e.g., {"amount": "10000", "dealstage": "closedwon"}) |
| 参数 | 类型 | 描述 |
|---|
deal | object | HubSpot deal record |
↳ 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 |
dealId | string | The updated deal ID |
success | boolean | Operation success status |
Search for deals in HubSpot using filters, sorting, and queries
| 参数 | 类型 | 必填 | 描述 |
|---|
filterGroups | array | 否 | 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 | 否 | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | 否 | Search query string to match against deal name and other text fields |
properties | array | 否 | Array of HubSpot property names to return (e.g., ["dealname", "amount", "dealstage"]) |
limit | number | 否 | Maximum number of results to return (max 200) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
deals | array | Array of HubSpot deal records |
↳ 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 |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| 参数 | 类型 | 描述 |
|---|
tickets | array | Array of HubSpot ticket records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
ticketId | string | 是 | The HubSpot ticket ID to retrieve |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| 参数 | 类型 | 描述 |
|---|
ticket | object | HubSpot ticket record |
↳ 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) |
ticketId | string | The retrieved ticket ID |
success | boolean | Operation success status |
Create a new ticket in HubSpot. Requires subject and hs_pipeline_stage properties
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | 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 | 否 | Array of associations to create with the ticket as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| 参数 | 类型 | 描述 |
|---|
ticket | object | HubSpot ticket record |
↳ 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) |
ticketId | string | The created ticket ID |
success | boolean | Operation success status |
Update an existing ticket in HubSpot by ID
| 参数 | 类型 | 必填 | 描述 |
|---|
ticketId | string | 是 | The HubSpot ticket ID to update |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | object | 是 | Ticket properties to update as JSON object (e.g., {"subject": "Updated subject", "hs_ticket_priority": "HIGH"}) |
| 参数 | 类型 | 描述 |
|---|
ticket | object | HubSpot ticket record |
↳ 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) |
ticketId | string | The updated ticket ID |
success | boolean | Operation success status |
Search for tickets in HubSpot using filters, sorting, and queries
| 参数 | 类型 | 必填 | 描述 |
|---|
filterGroups | array | 否 | 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 | 否 | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | 否 | Search query string to match against ticket subject and other text fields |
properties | array | 否 | Array of HubSpot property names to return (e.g., ["subject", "content", "hs_ticket_priority"]) |
limit | number | 否 | Maximum number of results to return (max 200) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
tickets | array | Array of HubSpot ticket records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| 参数 | 类型 | 描述 |
|---|
notes | array | Array of HubSpot note records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
noteId | string | 是 | The HubSpot note ID to retrieve |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| 参数 | 类型 | 描述 |
|---|
note | object | HubSpot note record |
↳ 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) |
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
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | 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 | 否 | 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) |
| 参数 | 类型 | 描述 |
|---|
note | object | HubSpot note record |
↳ 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) |
noteId | string | The created note ID |
success | boolean | Operation success status |
Search for notes in HubSpot using filters, sorting, and queries
| 参数 | 类型 | 必填 | 描述 |
|---|
filterGroups | array | 否 | 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 | 否 | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | 否 | Search query string to match against note text fields |
properties | array | 否 | Array of HubSpot property names to return (e.g., ["hs_note_body", "hs_timestamp", "hubspot_owner_id"]) |
limit | number | 否 | Maximum number of results to return (max 100) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
notes | array | Array of HubSpot note records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| 参数 | 类型 | 描述 |
|---|
emails | array | Array of HubSpot email engagement records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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)
| 参数 | 类型 | 必填 | 描述 |
|---|
emailId | string | 是 | The HubSpot email engagement ID to retrieve |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals") |
| 参数 | 类型 | 描述 |
|---|
email | object | HubSpot email engagement record |
↳ 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) |
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
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | 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 | 否 | Array of associations as JSON. Each object has "to.id" (record ID) and "types" array with "associationCategory" ("HUBSPOT_DEFINED") and "associationTypeId" (198 = email→contact) |
| 参数 | 类型 | 描述 |
|---|
email | object | HubSpot email engagement record |
↳ 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) |
emailId | string | The created email engagement ID |
success | boolean | Operation success status |
Search for email engagements in HubSpot using filters, sorting, and queries
| 参数 | 类型 | 必填 | 描述 |
|---|
filterGroups | array | 否 | 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 | 否 | Array of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING") |
query | string | 否 | Search query string to match against email text fields |
properties | array | 否 | Array of HubSpot property names to return (e.g., ["hs_email_subject", "hs_email_text", "hs_timestamp"]) |
limit | number | 否 | Maximum number of results to return (max 100) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
emails | array | Array of HubSpot email engagement records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
objectType | string | 是 | Object type to read properties for (e.g., "contacts", "companies", "deals", "tickets", "line_items", "quotes") |
propertyName | string | 否 | Internal name of a single property to retrieve (e.g., "hs_lead_status"). Omit to return all properties for the object type |
archived | boolean | 否 | Whether to return only archived properties (default false) |
| 参数 | 类型 | 描述 |
|---|
properties | array | Array of HubSpot property definitions |
↳ 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 |
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
| 参数 | 类型 | 必填 | 描述 |
|---|
objectType | string | 是 | Source object type (e.g., "contacts", "companies", "deals") |
objectId | string | 是 | ID of the source record |
toObjectType | string | 是 | Target object type to list associations to (e.g., "emails", "notes", "deals") |
limit | string | 否 | Maximum number of associated records per page (default 500) |
after | string | 否 | Pagination cursor for next page (from previous response) |
| 参数 | 类型 | 描述 |
|---|
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 |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
objectType | string | 是 | Source object type (e.g., "emails", "notes", "contacts") |
objectId | string | 是 | ID of the source record |
toObjectType | string | 是 | Target object type to associate to (e.g., "contacts", "companies", "deals") |
toObjectId | string | 是 | ID of the target record |
associationCategory | string | 否 | 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 | 否 | Specific association type ID for a labeled association. Omit to create the default association for the object pair |
| 参数 | 类型 | 描述 |
|---|
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 |
Retrieve all line items from HubSpot account with pagination support
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes") |
| 参数 | 类型 | 描述 |
|---|
lineItems | array | Array of HubSpot line item records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
lineItemId | string | 是 | The HubSpot line item ID to retrieve |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes") |
| 参数 | 类型 | 描述 |
|---|
lineItem | object | HubSpot line item record |
↳ 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) |
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
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | Line item properties as JSON object (e.g., {"name": "Product A", "quantity": "2", "price": "50.00", "hs_sku": "SKU-001"}) |
associations | array | 否 | Array of associations to create with the line item as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| 参数 | 类型 | 描述 |
|---|
lineItem | object | HubSpot line item record |
↳ 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) |
lineItemId | string | The created line item ID |
success | boolean | Operation success status |
Update an existing line item in HubSpot by ID
| 参数 | 类型 | 必填 | 描述 |
|---|
lineItemId | string | 是 | The HubSpot line item ID to update |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | object | 是 | Line item properties to update as JSON object (e.g., {"quantity": "5", "price": "25.00"}) |
| 参数 | 类型 | 描述 |
|---|
lineItem | object | HubSpot line item record |
↳ 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) |
lineItemId | string | The updated line item ID |
success | boolean | Operation success status |
Retrieve all quotes from HubSpot account with pagination support
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items") |
| 参数 | 类型 | 描述 |
|---|
quotes | array | Array of HubSpot quote records |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
quoteId | string | 是 | The HubSpot quote ID to retrieve |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items") |
| 参数 | 类型 | 描述 |
|---|
quote | object | HubSpot quote record |
↳ 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) |
quoteId | string | The retrieved quote ID |
success | boolean | Operation success status |
Retrieve all appointments from HubSpot account with pagination support
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_appointment_title,hs_appointment_start_time") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| 参数 | 类型 | 描述 |
|---|
appointments | array | Array of HubSpot appointment records |
↳ hs_appointment_type | string | Appointment type |
↳ hs_appointment_title | string | Appointment title |
↳ hs_appointment_start_time | string | Start time (ISO 8601) |
↳ hs_appointment_end_time | string | End time (ISO 8601) |
↳ hs_appointment_location | string | Appointment location |
↳ 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) |
paging | object | Pagination information for fetching more results |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
appointmentId | string | 是 | The HubSpot appointment ID to retrieve |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | string | 否 | Comma-separated list of HubSpot property names to return (e.g., "hs_appointment_title,hs_appointment_start_time") |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies") |
| 参数 | 类型 | 描述 |
|---|
appointment | object | HubSpot appointment record |
↳ hs_appointment_type | string | Appointment type |
↳ hs_appointment_title | string | Appointment title |
↳ hs_appointment_start_time | string | Start time (ISO 8601) |
↳ hs_appointment_end_time | string | End time (ISO 8601) |
↳ hs_appointment_location | string | Appointment location |
↳ 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) |
appointmentId | string | The retrieved appointment ID |
success | boolean | Operation success status |
Create a new appointment in HubSpot
| 参数 | 类型 | 必填 | 描述 |
|---|
properties | object | 是 | Appointment properties as JSON object (e.g., {"hs_appointment_title": "Discovery Call", "hs_appointment_start_time": "2024-01-15T10:00:00Z", "hs_appointment_end_time": "2024-01-15T11:00:00Z"}) |
associations | array | 否 | Array of associations to create with the appointment as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId" |
| 参数 | 类型 | 描述 |
|---|
appointment | object | HubSpot appointment record |
↳ hs_appointment_type | string | Appointment type |
↳ hs_appointment_title | string | Appointment title |
↳ hs_appointment_start_time | string | Start time (ISO 8601) |
↳ hs_appointment_end_time | string | End time (ISO 8601) |
↳ hs_appointment_location | string | Appointment location |
↳ 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) |
appointmentId | string | The created appointment ID |
success | boolean | Operation success status |
Update an existing appointment in HubSpot by ID
| 参数 | 类型 | 必填 | 描述 |
|---|
appointmentId | string | 是 | The HubSpot appointment ID to update |
idProperty | string | 否 | Property to use as unique identifier. If not specified, uses record ID |
properties | object | 是 | Appointment properties to update as JSON object (e.g., {"hs_appointment_title": "Updated Call", "hs_appointment_location": "Zoom"}) |
| 参数 | 类型 | 描述 |
|---|
appointment | object | HubSpot appointment record |
↳ hs_appointment_type | string | Appointment type |
↳ hs_appointment_title | string | Appointment title |
↳ hs_appointment_start_time | string | Start time (ISO 8601) |
↳ hs_appointment_end_time | string | End time (ISO 8601) |
↳ hs_appointment_location | string | Appointment location |
↳ 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) |
appointmentId | string | The updated appointment ID |
success | boolean | Operation success status |
Retrieve all carts from HubSpot account with pagination support
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
properties | string | 否 | Comma-separated list of HubSpot property names to return |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for |
| 参数 | 类型 | 描述 |
|---|
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 |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
cartId | string | 是 | The HubSpot cart ID to retrieve |
properties | string | 否 | Comma-separated list of HubSpot property names to return |
associations | string | 否 | Comma-separated list of object types to retrieve associated IDs for |
| 参数 | 类型 | 描述 |
|---|
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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 100) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
email | string | 否 | Filter owners by email address |
| 参数 | 类型 | 描述 |
|---|
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 |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
limit | string | 否 | Maximum number of results per page (max 100, default 10) |
after | string | 否 | Pagination cursor for next page of results (from previous response) |
| 参数 | 类型 | 描述 |
|---|
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 |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
eventId | string | 是 | The HubSpot marketing event objectId to retrieve |
| 参数 | 类型 | 描述 |
|---|
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
| 参数 | 类型 | 必填 | 描述 |
|---|
query | string | 否 | Search query to filter lists by name. Leave empty to return all lists. |
count | string | 否 | Maximum number of results to return (default 20, max 500) |
offset | string | 否 | Pagination offset for next page of results (use the offset value from previous response) |
| 参数 | 类型 | 描述 |
|---|
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 |
↳ 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
| 参数 | 类型 | 必填 | 描述 |
|---|
listId | string | 是 | The HubSpot list ID to retrieve |
| 参数 | 类型 | 描述 |
|---|
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)
| 参数 | 类型 | 必填 | 描述 |
|---|
name | string | 是 | Name of the list |
objectTypeId | string | 是 | Object type ID (e.g., "0-1" for contacts, "0-2" for companies) |
processingType | string | 是 | Processing type: "MANUAL" for static lists or "DYNAMIC" for active lists |
| 参数 | 类型 | 描述 |
|---|
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 |
