HubSpot

HubSpot is a comprehensive CRM platform that provides a full suite of marketing, sales, and customer service tools to help businesses grow. With powerful automation capabilities and an extensive API, HubSpot serves businesses of all sizes across industries.

With the HubSpot integration in Sim, you can:

  • Manage contacts: List, get, create, update, and search contacts in your CRM
  • Manage companies: List, get, create, update, and search company records
  • Track deals: List deals in your sales pipeline
  • Access users: Retrieve user information from your HubSpot account

In Sim, the HubSpot integration enables your agents to interact with your CRM data as part of automated workflows. Agents can qualify leads, enrich contact records, track deals, and synchronize data across your tech stack—enabling intelligent sales and marketing automation.

New to the integration? Follow the HubSpot setup guide to install it, connect your account, and configure your first workflow.

Usage Instructions

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 records are created, updated, a specific property changes, or a contact joins a list.

Actions

Get Users from HubSpot

Retrieve all users from HubSpot account

Input

ParameterTypeRequiredDescription
limitstringNoNumber of results to return (default: 10, max: 100)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot user property names to return (e.g., "hs_email,hs_given_name,hs_family_name")

Output

ParameterTypeDescription
usersarrayArray of HubSpot CRM records
↳ idstringUnique record ID (hs_object_id)
↳ createdAtstringRecord creation timestamp (ISO 8601)
↳ updatedAtstringRecord last updated timestamp (ISO 8601)
↳ archivedbooleanWhether the record is archived
↳ propertiesobjectRecord properties
↳ associationsobjectAssociated records
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
totalItemsnumberTotal number of users returned
successbooleanOperation success status

List Contacts from HubSpot

Retrieve all contacts from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals")

Output

ParameterTypeDescription
contactsarrayArray of HubSpot contact records
↳ emailstringContact email address
↳ firstnamestringContact first name
↳ lastnamestringContact last name
↳ phonestringContact phone number
↳ mobilephonestringContact mobile phone number
↳ companystringAssociated company name
↳ websitestringContact website URL
↳ jobtitlestringContact job title
↳ lifecyclestagestringLifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringContact creation date (ISO 8601)
↳ lastmodifieddatestringLast modified date (ISO 8601)
↳ addressstringStreet address
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ faxstringFax number
↳ hs_timezonestringContact timezone
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Contact from HubSpot

Retrieve a single contact by ID or email from HubSpot

Input

ParameterTypeRequiredDescription
contactIdstringYesThe HubSpot contact ID (numeric string) or email address to retrieve
idPropertystringNoProperty to use as unique identifier (e.g., "email"). If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals")

Output

ParameterTypeDescription
contactobjectHubSpot contact record
↳ emailstringContact email address
↳ firstnamestringContact first name
↳ lastnamestringContact last name
↳ phonestringContact phone number
↳ mobilephonestringContact mobile phone number
↳ companystringAssociated company name
↳ websitestringContact website URL
↳ jobtitlestringContact job title
↳ lifecyclestagestringLifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringContact creation date (ISO 8601)
↳ lastmodifieddatestringLast modified date (ISO 8601)
↳ addressstringStreet address
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ faxstringFax number
↳ hs_timezonestringContact timezone
contactIdstringThe retrieved contact ID
successbooleanOperation success status

Create Contact in HubSpot

Create a new contact in HubSpot. Requires at least one of: email, firstname, or lastname

Input

ParameterTypeRequiredDescription
propertiesobjectYesContact properties as JSON object. Must include at least one of: email, firstname, or lastname (e.g., {"email": "john@example.com", "firstname": "John", "lastname": "Doe"})
associationsarrayNoArray 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"

Output

ParameterTypeDescription
contactobjectHubSpot contact record
↳ emailstringContact email address
↳ firstnamestringContact first name
↳ lastnamestringContact last name
↳ phonestringContact phone number
↳ mobilephonestringContact mobile phone number
↳ companystringAssociated company name
↳ websitestringContact website URL
↳ jobtitlestringContact job title
↳ lifecyclestagestringLifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringContact creation date (ISO 8601)
↳ lastmodifieddatestringLast modified date (ISO 8601)
↳ addressstringStreet address
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ faxstringFax number
↳ hs_timezonestringContact timezone
contactIdstringThe created contact ID
successbooleanOperation success status

Update Contact in HubSpot

Update an existing contact in HubSpot by ID or email

Input

ParameterTypeRequiredDescription
contactIdstringYesThe HubSpot contact ID (numeric string) or email of the contact to update
idPropertystringNoProperty to use as unique identifier (e.g., "email"). If not specified, uses record ID
propertiesobjectYesContact properties to update as JSON object (e.g., {"firstname": "John", "phone": "+1234567890"})

Output

ParameterTypeDescription
contactobjectHubSpot contact record
↳ emailstringContact email address
↳ firstnamestringContact first name
↳ lastnamestringContact last name
↳ phonestringContact phone number
↳ mobilephonestringContact mobile phone number
↳ companystringAssociated company name
↳ websitestringContact website URL
↳ jobtitlestringContact job title
↳ lifecyclestagestringLifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringContact creation date (ISO 8601)
↳ lastmodifieddatestringLast modified date (ISO 8601)
↳ addressstringStreet address
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ faxstringFax number
↳ hs_timezonestringContact timezone
contactIdstringThe updated contact ID
successbooleanOperation success status

Search Contacts in HubSpot

Search for contacts in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against contact name, email, and other text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["email", "firstname", "lastname", "phone"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
contactsarrayArray of HubSpot contact records
↳ emailstringContact email address
↳ firstnamestringContact first name
↳ lastnamestringContact last name
↳ phonestringContact phone number
↳ mobilephonestringContact mobile phone number
↳ companystringAssociated company name
↳ websitestringContact website URL
↳ jobtitlestringContact job title
↳ lifecyclestagestringLifecycle stage (subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringContact creation date (ISO 8601)
↳ lastmodifieddatestringLast modified date (ISO 8601)
↳ addressstringStreet address
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ faxstringFax number
↳ hs_timezonestringContact timezone
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching contacts
successbooleanOperation success status

List Companies from HubSpot

Retrieve all companies from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "name,domain,industry")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals")

Output

ParameterTypeDescription
companiesarrayArray of HubSpot company records
↳ namestringCompany name
↳ domainstringCompany website domain (unique identifier)
↳ descriptionstringCompany description
↳ industrystringIndustry type (e.g., Airlines/Aviation)
↳ phonestringCompany phone number
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ addressstringStreet address
↳ numberofemployeesstringTotal number of employees
↳ annualrevenuestringAnnual revenue estimate
↳ lifecyclestagestringLifecycle stage
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCompany creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ hs_additional_domainsstringAdditional domains (semicolon-separated)
↳ num_associated_contactsstringNumber of associated contacts (auto-updated)
↳ num_associated_dealsstringNumber of associated deals (auto-updated)
↳ websitestringCompany website URL
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Company from HubSpot

Retrieve a single company by ID or domain from HubSpot

Input

ParameterTypeRequiredDescription
companyIdstringYesThe HubSpot company ID (numeric string) or domain to retrieve
idPropertystringNoProperty to use as unique identifier (e.g., "domain"). If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "name,domain,industry")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals")

Output

ParameterTypeDescription
companyobjectHubSpot company record
↳ namestringCompany name
↳ domainstringCompany website domain (unique identifier)
↳ descriptionstringCompany description
↳ industrystringIndustry type (e.g., Airlines/Aviation)
↳ phonestringCompany phone number
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ addressstringStreet address
↳ numberofemployeesstringTotal number of employees
↳ annualrevenuestringAnnual revenue estimate
↳ lifecyclestagestringLifecycle stage
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCompany creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ hs_additional_domainsstringAdditional domains (semicolon-separated)
↳ num_associated_contactsstringNumber of associated contacts (auto-updated)
↳ num_associated_dealsstringNumber of associated deals (auto-updated)
↳ websitestringCompany website URL
companyIdstringThe retrieved company ID
successbooleanOperation success status

Create Company in HubSpot

Create a new company in HubSpot

Input

ParameterTypeRequiredDescription
propertiesobjectYesCompany properties as JSON object (e.g., {"name": "Acme Inc", "domain": "acme.com", "industry": "Technology"})
associationsarrayNoArray of associations to create with the company as JSON (each with "to.id" and "types" containing "associationCategory" and "associationTypeId")

Output

ParameterTypeDescription
companyobjectHubSpot company record
↳ namestringCompany name
↳ domainstringCompany website domain (unique identifier)
↳ descriptionstringCompany description
↳ industrystringIndustry type (e.g., Airlines/Aviation)
↳ phonestringCompany phone number
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ addressstringStreet address
↳ numberofemployeesstringTotal number of employees
↳ annualrevenuestringAnnual revenue estimate
↳ lifecyclestagestringLifecycle stage
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCompany creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ hs_additional_domainsstringAdditional domains (semicolon-separated)
↳ num_associated_contactsstringNumber of associated contacts (auto-updated)
↳ num_associated_dealsstringNumber of associated deals (auto-updated)
↳ websitestringCompany website URL
companyIdstringThe created company ID
successbooleanOperation success status

Update Company in HubSpot

Update an existing company in HubSpot by ID or domain

Input

ParameterTypeRequiredDescription
companyIdstringYesThe HubSpot company ID (numeric string) or domain of the company to update
idPropertystringNoProperty to use as unique identifier (e.g., "domain"). If not specified, uses record ID
propertiesobjectYesCompany properties to update as JSON object (e.g., {"name": "New Name", "industry": "Finance"})

Output

ParameterTypeDescription
companyobjectHubSpot company record
↳ namestringCompany name
↳ domainstringCompany website domain (unique identifier)
↳ descriptionstringCompany description
↳ industrystringIndustry type (e.g., Airlines/Aviation)
↳ phonestringCompany phone number
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ addressstringStreet address
↳ numberofemployeesstringTotal number of employees
↳ annualrevenuestringAnnual revenue estimate
↳ lifecyclestagestringLifecycle stage
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCompany creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ hs_additional_domainsstringAdditional domains (semicolon-separated)
↳ num_associated_contactsstringNumber of associated contacts (auto-updated)
↳ num_associated_dealsstringNumber of associated deals (auto-updated)
↳ websitestringCompany website URL
companyIdstringThe updated company ID
successbooleanOperation success status

Search Companies in HubSpot

Search for companies in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against company name, domain, and other text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["name", "domain", "industry"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
companiesarrayArray of HubSpot company records
↳ namestringCompany name
↳ domainstringCompany website domain (unique identifier)
↳ descriptionstringCompany description
↳ industrystringIndustry type (e.g., Airlines/Aviation)
↳ phonestringCompany phone number
↳ citystringCity
↳ statestringState/Region
↳ zipstringPostal/ZIP code
↳ countrystringCountry
↳ addressstringStreet address
↳ numberofemployeesstringTotal number of employees
↳ annualrevenuestringAnnual revenue estimate
↳ lifecyclestagestringLifecycle stage
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCompany creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ hs_additional_domainsstringAdditional domains (semicolon-separated)
↳ num_associated_contactsstringNumber of associated contacts (auto-updated)
↳ num_associated_dealsstringNumber of associated deals (auto-updated)
↳ websitestringCompany website URL
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching companies
successbooleanOperation success status

List Deals from HubSpot

Retrieve all deals from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Output

ParameterTypeDescription
dealsarrayArray of HubSpot deal records
↳ dealnamestringDeal name
↳ amountstringDeal amount
↳ dealstagestringCurrent deal stage
↳ pipelinestringPipeline the deal is in
↳ closedatestringExpected close date (ISO 8601)
↳ dealtypestringDeal type (New Business, Existing Business, etc.)
↳ descriptionstringDeal description
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringDeal creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ num_associated_contactsstringNumber of associated contacts
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Deal from HubSpot

Retrieve a single deal by ID from HubSpot

Input

ParameterTypeRequiredDescription
dealIdstringYesThe HubSpot deal ID to retrieve
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Output

ParameterTypeDescription
dealobjectHubSpot deal record
↳ dealnamestringDeal name
↳ amountstringDeal amount
↳ dealstagestringCurrent deal stage
↳ pipelinestringPipeline the deal is in
↳ closedatestringExpected close date (ISO 8601)
↳ dealtypestringDeal type (New Business, Existing Business, etc.)
↳ descriptionstringDeal description
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringDeal creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ num_associated_contactsstringNumber of associated contacts
dealIdstringThe retrieved deal ID
successbooleanOperation success status

Create Deal in HubSpot

Create a new deal in HubSpot with the given properties (e.g., dealname, amount, dealstage)

Input

ParameterTypeRequiredDescription
propertiesobjectYesDeal 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"})
associationsarrayNoArray of associations to create with the deal as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId"

Output

ParameterTypeDescription
dealobjectHubSpot deal record
↳ dealnamestringDeal name
↳ amountstringDeal amount
↳ dealstagestringCurrent deal stage
↳ pipelinestringPipeline the deal is in
↳ closedatestringExpected close date (ISO 8601)
↳ dealtypestringDeal type (New Business, Existing Business, etc.)
↳ descriptionstringDeal description
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringDeal creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ num_associated_contactsstringNumber of associated contacts
dealIdstringThe created deal ID
successbooleanOperation success status

Update Deal in HubSpot

Update an existing deal in HubSpot by ID

Input

ParameterTypeRequiredDescription
dealIdstringYesThe HubSpot deal ID to update
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectYesDeal properties to update as JSON object (e.g., {"amount": "10000", "dealstage": "closedwon"})

Output

ParameterTypeDescription
dealobjectHubSpot deal record
↳ dealnamestringDeal name
↳ amountstringDeal amount
↳ dealstagestringCurrent deal stage
↳ pipelinestringPipeline the deal is in
↳ closedatestringExpected close date (ISO 8601)
↳ dealtypestringDeal type (New Business, Existing Business, etc.)
↳ descriptionstringDeal description
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringDeal creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ num_associated_contactsstringNumber of associated contacts
dealIdstringThe updated deal ID
successbooleanOperation success status

Search Deals in HubSpot

Search for deals in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray 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"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against deal name and other text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["dealname", "amount", "dealstage"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
dealsarrayArray of HubSpot deal records
↳ dealnamestringDeal name
↳ amountstringDeal amount
↳ dealstagestringCurrent deal stage
↳ pipelinestringPipeline the deal is in
↳ closedatestringExpected close date (ISO 8601)
↳ dealtypestringDeal type (New Business, Existing Business, etc.)
↳ descriptionstringDeal description
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringDeal creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
↳ num_associated_contactsstringNumber of associated contacts
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching deals
successbooleanOperation success status

List Tickets from HubSpot

Retrieve all tickets from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Output

ParameterTypeDescription
ticketsarrayArray of HubSpot ticket records
↳ subjectstringTicket subject/name
↳ contentstringTicket content/description
↳ hs_pipelinestringPipeline the ticket is in
↳ hs_pipeline_stagestringCurrent pipeline stage
↳ hs_ticket_prioritystringTicket priority (LOW, MEDIUM, HIGH)
↳ hs_ticket_categorystringTicket category
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringTicket creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Ticket from HubSpot

Retrieve a single ticket by ID from HubSpot

Input

ParameterTypeRequiredDescription
ticketIdstringYesThe HubSpot ticket ID to retrieve
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Output

ParameterTypeDescription
ticketobjectHubSpot ticket record
↳ subjectstringTicket subject/name
↳ contentstringTicket content/description
↳ hs_pipelinestringPipeline the ticket is in
↳ hs_pipeline_stagestringCurrent pipeline stage
↳ hs_ticket_prioritystringTicket priority (LOW, MEDIUM, HIGH)
↳ hs_ticket_categorystringTicket category
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringTicket creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
ticketIdstringThe retrieved ticket ID
successbooleanOperation success status

Create Ticket in HubSpot

Create a new ticket in HubSpot. Requires subject and hs_pipeline_stage properties

Input

ParameterTypeRequiredDescription
propertiesobjectYesTicket properties as JSON object. Must include subject and hs_pipeline_stage (e.g., {"subject": "Support request", "hs_pipeline_stage": "1", "hs_ticket_priority": "HIGH"})
associationsarrayNoArray of associations to create with the ticket as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId"

Output

ParameterTypeDescription
ticketobjectHubSpot ticket record
↳ subjectstringTicket subject/name
↳ contentstringTicket content/description
↳ hs_pipelinestringPipeline the ticket is in
↳ hs_pipeline_stagestringCurrent pipeline stage
↳ hs_ticket_prioritystringTicket priority (LOW, MEDIUM, HIGH)
↳ hs_ticket_categorystringTicket category
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringTicket creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
ticketIdstringThe created ticket ID
successbooleanOperation success status

Update Ticket in HubSpot

Update an existing ticket in HubSpot by ID

Input

ParameterTypeRequiredDescription
ticketIdstringYesThe HubSpot ticket ID to update
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectYesTicket properties to update as JSON object (e.g., {"subject": "Updated subject", "hs_ticket_priority": "HIGH"})

Output

ParameterTypeDescription
ticketobjectHubSpot ticket record
↳ subjectstringTicket subject/name
↳ contentstringTicket content/description
↳ hs_pipelinestringPipeline the ticket is in
↳ hs_pipeline_stagestringCurrent pipeline stage
↳ hs_ticket_prioritystringTicket priority (LOW, MEDIUM, HIGH)
↳ hs_ticket_categorystringTicket category
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringTicket creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
ticketIdstringThe updated ticket ID
successbooleanOperation success status

Search Tickets in HubSpot

Search for tickets in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray 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"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against ticket subject and other text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["subject", "content", "hs_ticket_priority"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
ticketsarrayArray of HubSpot ticket records
↳ subjectstringTicket subject/name
↳ contentstringTicket content/description
↳ hs_pipelinestringPipeline the ticket is in
↳ hs_pipeline_stagestringCurrent pipeline stage
↳ hs_ticket_prioritystringTicket priority (LOW, MEDIUM, HIGH)
↳ hs_ticket_categorystringTicket category
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringTicket creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching tickets
successbooleanOperation success status

List Notes from HubSpot

Retrieve all notes from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")

Output

ParameterTypeDescription
notesarrayArray of HubSpot note records
↳ hs_note_bodystringNote text/body (supports rich text/HTML)
↳ hs_timestampstringNote activity time (ISO 8601)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_attachment_idsstringSemicolon-separated IDs of files attached to the note
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringNote creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Note from HubSpot

Retrieve a single note by ID from HubSpot

Input

ParameterTypeRequiredDescription
noteIdstringYesThe HubSpot note ID to retrieve
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")

Output

ParameterTypeDescription
noteobjectHubSpot note record
↳ hs_note_bodystringNote text/body (supports rich text/HTML)
↳ hs_timestampstringNote activity time (ISO 8601)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_attachment_idsstringSemicolon-separated IDs of files attached to the note
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringNote creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
noteIdstringThe retrieved note ID
successbooleanOperation success status

Create Note in HubSpot

Log a note in HubSpot and optionally associate it with contacts, companies, or deals. Requires hs_timestamp and hs_note_body properties

Input

ParameterTypeRequiredDescription
propertiesobjectYesNote 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"}
associationsarrayNoArray 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)

Output

ParameterTypeDescription
noteobjectHubSpot note record
↳ hs_note_bodystringNote text/body (supports rich text/HTML)
↳ hs_timestampstringNote activity time (ISO 8601)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_attachment_idsstringSemicolon-separated IDs of files attached to the note
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringNote creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
noteIdstringThe created note ID
successbooleanOperation success status

Search Notes in HubSpot

Search for notes in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against note text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["hs_note_body", "hs_timestamp", "hubspot_owner_id"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
notesarrayArray of HubSpot note records
↳ hs_note_bodystringNote text/body (supports rich text/HTML)
↳ hs_timestampstringNote activity time (ISO 8601)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_attachment_idsstringSemicolon-separated IDs of files attached to the note
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringNote creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching notes
successbooleanOperation success status

List Emails from HubSpot

Retrieve all email engagements from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")

Output

ParameterTypeDescription
emailsarrayArray of HubSpot email engagement records
↳ hs_timestampstringEmail activity time (ISO 8601)
↳ hs_email_directionstringDirection (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL)
↳ hs_email_statusstringSend status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED)
↳ hs_email_subjectstringEmail subject line
↳ hs_email_textstringPlain-text email body
↳ hs_email_htmlstringHTML email body
↳ hs_email_headersstringJSON-encoded from/to/cc/bcc headers
↳ hs_email_from_emailstringSender email address
↳ hs_email_to_emailstringRecipient email address(es)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringEmail creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Email from HubSpot

Retrieve a single email engagement by ID from HubSpot (content requires the sales-email-read scope)

Input

ParameterTypeRequiredDescription
emailIdstringYesThe HubSpot email engagement ID to retrieve
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")

Output

ParameterTypeDescription
emailobjectHubSpot email engagement record
↳ hs_timestampstringEmail activity time (ISO 8601)
↳ hs_email_directionstringDirection (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL)
↳ hs_email_statusstringSend status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED)
↳ hs_email_subjectstringEmail subject line
↳ hs_email_textstringPlain-text email body
↳ hs_email_htmlstringHTML email body
↳ hs_email_headersstringJSON-encoded from/to/cc/bcc headers
↳ hs_email_from_emailstringSender email address
↳ hs_email_to_emailstringRecipient email address(es)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringEmail creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
emailIdstringThe retrieved email engagement ID
successbooleanOperation success status

Create Email in HubSpot

Log an email engagement in HubSpot and optionally associate it with contacts. Requires the hs_timestamp property

Input

ParameterTypeRequiredDescription
propertiesobjectYesEmail 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)
associationsarrayNoArray of associations as JSON. Each object has "to.id" (record ID) and "types" array with "associationCategory" ("HUBSPOT_DEFINED") and "associationTypeId" (198 = email→contact)

Output

ParameterTypeDescription
emailobjectHubSpot email engagement record
↳ hs_timestampstringEmail activity time (ISO 8601)
↳ hs_email_directionstringDirection (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL)
↳ hs_email_statusstringSend status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED)
↳ hs_email_subjectstringEmail subject line
↳ hs_email_textstringPlain-text email body
↳ hs_email_htmlstringHTML email body
↳ hs_email_headersstringJSON-encoded from/to/cc/bcc headers
↳ hs_email_from_emailstringSender email address
↳ hs_email_to_emailstringRecipient email address(es)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringEmail creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
emailIdstringThe created email engagement ID
successbooleanOperation success status

Search Emails in HubSpot

Search for email engagements in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against email text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["hs_email_subject", "hs_email_text", "hs_timestamp"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
emailsarrayArray of HubSpot email engagement records
↳ hs_timestampstringEmail activity time (ISO 8601)
↳ hs_email_directionstringDirection (EMAIL = outgoing, INCOMING_EMAIL, FORWARDED_EMAIL)
↳ hs_email_statusstringSend status (SENT, SENDING, SCHEDULED, FAILED, BOUNCED)
↳ hs_email_subjectstringEmail subject line
↳ hs_email_textstringPlain-text email body
↳ hs_email_htmlstringHTML email body
↳ hs_email_headersstringJSON-encoded from/to/cc/bcc headers
↳ hs_email_from_emailstringSender email address
↳ hs_email_to_emailstringRecipient email address(es)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringEmail creation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching emails
successbooleanOperation success status

Get Properties from HubSpot

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

Input

ParameterTypeRequiredDescription
objectTypestringYesObject type to read properties for (e.g., "contacts", "companies", "deals", "tickets", "line_items", "quotes")
propertyNamestringNoInternal name of a single property to retrieve (e.g., "hs_lead_status"). Omit to return all properties for the object type
archivedbooleanNoWhether to return only archived properties (default false)

Output

ParameterTypeDescription
propertiesarrayArray of HubSpot property definitions
↳ labelstringHuman-readable option label
↳ valuestringInternal value used when setting the property
↳ displayOrdernumberDisplay order (-1 sorts last)
↳ hiddenbooleanWhether the option is hidden in the HubSpot UI
↳ descriptionstringOption description
metadataobjectResponse metadata
↳ totalReturnednumberNumber of property definitions returned
↳ objectTypestringObject type the properties belong to
successbooleanOperation success status

List Associations in HubSpot

List records of one object type associated with a given record, e.g. all emails or notes logged on a contact

Input

ParameterTypeRequiredDescription
objectTypestringYesSource object type (e.g., "contacts", "companies", "deals")
objectIdstringYesID of the source record
toObjectTypestringYesTarget object type to list associations to (e.g., "emails", "notes", "deals")
limitstringNoMaximum number of associated records per page (default 500)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
resultsarrayArray of associated records
↳ toObjectIdstringID of the associated (target) record
↳ associationTypesarrayAssociation types linking the two records
↳ categorystringAssociation category (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED)
↳ typeIdnumberAssociation type ID
↳ labelstringAssociation label
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Create Association in HubSpot

Associate two HubSpot records. Creates the default (unlabeled) association unless an association type ID is provided

Input

ParameterTypeRequiredDescription
objectTypestringYesSource object type (e.g., "emails", "notes", "contacts")
objectIdstringYesID of the source record
toObjectTypestringYesTarget object type to associate to (e.g., "contacts", "companies", "deals")
toObjectIdstringYesID of the target record
associationCategorystringNoAssociation category for a labeled association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED). Defaults to HUBSPOT_DEFINED when an association type ID is provided
associationTypeIdnumberNoSpecific association type ID for a labeled association. Omit to create the default association for the object pair

Output

ParameterTypeDescription
fromObjectIdstringID of the source record
toObjectIdstringID of the associated target record
labelsarrayAssociation labels (empty for default associations)
successbooleanOperation success status

Delete Association in HubSpot

Remove all associations between two HubSpot records

Input

ParameterTypeRequiredDescription
objectTypestringYesThe source object type (e.g., "contacts", "companies", "deals")
objectIdstringYesThe ID of the source record
toObjectTypestringYesThe target object type (e.g., "emails", "notes", "contacts")
toObjectIdstringYesThe ID of the target record

Output

ParameterTypeDescription
fromObjectIdstringSource record ID
toObjectIdstringTarget record ID
deletedbooleanWhether the associations were removed
successbooleanOperation success status

Get Association Labels from HubSpot

Retrieve the association types (category, typeId, label) defined between two HubSpot object types

Input

ParameterTypeRequiredDescription
objectTypestringYesThe source object type (e.g., "contacts", "companies", "deals")
toObjectTypestringYesThe target object type (e.g., "emails", "notes", "contacts")

Output

ParameterTypeDescription
labelsarrayAssociation types defined between the two object types
↳ categorystringAssociation category (HUBSPOT_DEFINED or USER_DEFINED)
↳ typeIdnumberAssociation type ID
↳ labelstringHuman-readable label (null for unlabeled defaults)
successbooleanOperation success status

Delete Contact from HubSpot

Archive a contact in HubSpot by ID (moves it to the recycling bin)

Input

ParameterTypeRequiredDescription
contactIdstringYesThe numeric ID of the contact to delete

Output

ParameterTypeDescription
contactIdstringID of the deleted contact
deletedbooleanWhether the contact was archived
successbooleanOperation success status

Delete Company from HubSpot

Archive a company in HubSpot by ID (moves it to the recycling bin)

Input

ParameterTypeRequiredDescription
companyIdstringYesThe numeric ID of the company to delete

Output

ParameterTypeDescription
companyIdstringID of the deleted company
deletedbooleanWhether the company was archived
successbooleanOperation success status

Delete Deal from HubSpot

Archive a deal in HubSpot by ID (moves it to the recycling bin)

Input

ParameterTypeRequiredDescription
dealIdstringYesThe numeric ID of the deal to delete

Output

ParameterTypeDescription
dealIdstringID of the deleted deal
deletedbooleanWhether the deal was archived
successbooleanOperation success status

Delete Ticket from HubSpot

Archive a ticket in HubSpot by ID (moves it to the recycling bin)

Input

ParameterTypeRequiredDescription
ticketIdstringYesThe numeric ID of the ticket to delete

Output

ParameterTypeDescription
ticketIdstringID of the deleted ticket
deletedbooleanWhether the ticket was archived
successbooleanOperation success status

Delete Line Item from HubSpot

Archive a line item in HubSpot by ID (moves it to the recycling bin)

Input

ParameterTypeRequiredDescription
lineItemIdstringYesThe numeric ID of the line item to delete

Output

ParameterTypeDescription
lineItemIdstringID of the deleted line item
deletedbooleanWhether the line item was archived
successbooleanOperation success status

Search Line Items in HubSpot

Search for line items in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray 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"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against line item name and other text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["name", "quantity", "price"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
lineItemsarrayArray of HubSpot line item records
↳ namestringLine item name
↳ descriptionstringFull description of the product
↳ hs_skustringUnique product identifier (SKU)
↳ quantitystringNumber of units included
↳ pricestringUnit price
↳ amountstringTotal cost (quantity * unit price)
↳ hs_line_item_currency_codestringCurrency code
↳ recurringbillingfrequencystringRecurring billing frequency
↳ hs_recurring_billing_start_datestringRecurring billing start date
↳ hs_recurring_billing_end_datestringRecurring billing end date
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching line items
successbooleanOperation success status

Search Quotes in HubSpot

Search for quotes in HubSpot using filters, sorting, and queries

Input

ParameterTypeRequiredDescription
filterGroupsarrayNoArray 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"
sortsarrayNoArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNoSearch query string to match against quote title and other text fields
propertiesarrayNoArray of HubSpot property names to return (e.g., ["hs_title", "hs_expiration_date"])
limitnumberNoMaximum number of results to return (max 200, default 10)
afterstringNoPagination cursor for next page (from previous response)

Output

ParameterTypeDescription
quotesarrayArray of HubSpot quote records
↳ hs_titlestringQuote name/title
↳ hs_expiration_datestringExpiration date
↳ hs_statusstringQuote status
↳ hs_esign_enabledstringWhether e-signatures are enabled
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
totalnumberTotal number of matching quotes
successbooleanOperation success status

Get List Members from HubSpot

Retrieve the record IDs that are members of a HubSpot list, ordered by record ID

Input

ParameterTypeRequiredDescription
listIdstringYesThe ID of the list to read members from
limitstringNoMaximum number of results per page (max 250, default 100)
afterstringNoPagination cursor for next page of results (from previous response)

Output

ParameterTypeDescription
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
membershipsarrayRecords that are members of the list
↳ recordIdstringID of the member record
↳ membershipTimestampstringWhen the record was added to the list
successbooleanOperation success status

Add List Members in HubSpot

Add records to a manual (static) HubSpot list by record ID

Input

ParameterTypeRequiredDescription
listIdstringYesThe ID of the list to add records to (MANUAL or SNAPSHOT lists only)
recordIdsarrayYesRecord IDs to add to the list, as a JSON array (e.g., ["123","456"]) or comma-separated string

Output

ParameterTypeDescription
recordIdsAddedarrayIDs of the records that were added to the list
recordIdsMissingarrayIDs of the requested records that were not found
successbooleanOperation success status

Remove List Members in HubSpot

Remove records from a manual (static) HubSpot list by record ID

Input

ParameterTypeRequiredDescription
listIdstringYesThe ID of the list to remove records from (MANUAL or SNAPSHOT lists only)
recordIdsarrayYesRecord IDs to remove from the list, as a JSON array (e.g., ["123","456"]) or comma-separated string

Output

ParameterTypeDescription
recordIdsRemovedarrayIDs of the records that were removed from the list
recordIdsMissingarrayIDs of the requested records that were not found
successbooleanOperation success status

List Line Items from HubSpot

Retrieve all line items from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes")

Output

ParameterTypeDescription
lineItemsarrayArray of HubSpot line item records
↳ namestringLine item name
↳ descriptionstringFull description of the product
↳ hs_skustringUnique product identifier (SKU)
↳ quantitystringNumber of units included
↳ pricestringUnit price
↳ amountstringTotal cost (quantity * unit price)
↳ hs_line_item_currency_codestringCurrency code
↳ recurringbillingfrequencystringRecurring billing frequency
↳ hs_recurring_billing_start_datestringRecurring billing start date
↳ hs_recurring_billing_end_datestringRecurring billing end date
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Line Item from HubSpot

Retrieve a single line item by ID from HubSpot

Input

ParameterTypeRequiredDescription
lineItemIdstringYesThe HubSpot line item ID to retrieve
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "name,quantity,price,amount")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "deals,quotes")

Output

ParameterTypeDescription
lineItemobjectHubSpot line item record
↳ namestringLine item name
↳ descriptionstringFull description of the product
↳ hs_skustringUnique product identifier (SKU)
↳ quantitystringNumber of units included
↳ pricestringUnit price
↳ amountstringTotal cost (quantity * unit price)
↳ hs_line_item_currency_codestringCurrency code
↳ recurringbillingfrequencystringRecurring billing frequency
↳ hs_recurring_billing_start_datestringRecurring billing start date
↳ hs_recurring_billing_end_datestringRecurring billing end date
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
lineItemIdstringThe retrieved line item ID
successbooleanOperation success status

Create Line Item in HubSpot

Create a new line item in HubSpot. Requires at least a name property

Input

ParameterTypeRequiredDescription
propertiesobjectYesLine item properties as JSON object (e.g., {"name": "Product A", "quantity": "2", "price": "50.00", "hs_sku": "SKU-001"})
associationsarrayNoArray of associations to create with the line item as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId"

Output

ParameterTypeDescription
lineItemobjectHubSpot line item record
↳ namestringLine item name
↳ descriptionstringFull description of the product
↳ hs_skustringUnique product identifier (SKU)
↳ quantitystringNumber of units included
↳ pricestringUnit price
↳ amountstringTotal cost (quantity * unit price)
↳ hs_line_item_currency_codestringCurrency code
↳ recurringbillingfrequencystringRecurring billing frequency
↳ hs_recurring_billing_start_datestringRecurring billing start date
↳ hs_recurring_billing_end_datestringRecurring billing end date
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
lineItemIdstringThe created line item ID
successbooleanOperation success status

Update Line Item in HubSpot

Update an existing line item in HubSpot by ID

Input

ParameterTypeRequiredDescription
lineItemIdstringYesThe HubSpot line item ID to update
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectYesLine item properties to update as JSON object (e.g., {"quantity": "5", "price": "25.00"})

Output

ParameterTypeDescription
lineItemobjectHubSpot line item record
↳ namestringLine item name
↳ descriptionstringFull description of the product
↳ hs_skustringUnique product identifier (SKU)
↳ quantitystringNumber of units included
↳ pricestringUnit price
↳ amountstringTotal cost (quantity * unit price)
↳ hs_line_item_currency_codestringCurrency code
↳ recurringbillingfrequencystringRecurring billing frequency
↳ hs_recurring_billing_start_datestringRecurring billing start date
↳ hs_recurring_billing_end_datestringRecurring billing end date
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
lineItemIdstringThe updated line item ID
successbooleanOperation success status

List Quotes from HubSpot

Retrieve all quotes from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items")

Output

ParameterTypeDescription
quotesarrayArray of HubSpot quote records
↳ hs_titlestringQuote name/title
↳ hs_expiration_datestringExpiration date
↳ hs_statusstringQuote status
↳ hs_esign_enabledstringWhether e-signatures are enabled
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Quote from HubSpot

Retrieve a single quote by ID from HubSpot

Input

ParameterTypeRequiredDescription
quoteIdstringYesThe HubSpot quote ID to retrieve
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items")

Output

ParameterTypeDescription
quoteobjectHubSpot quote record
↳ hs_titlestringQuote name/title
↳ hs_expiration_datestringExpiration date
↳ hs_statusstringQuote status
↳ hs_esign_enabledstringWhether e-signatures are enabled
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
quoteIdstringThe retrieved quote ID
successbooleanOperation success status

List Appointments from HubSpot

Retrieve all appointments from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_appointment_name,hs_appointment_start")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Output

ParameterTypeDescription
appointmentsarrayArray of HubSpot appointment records
↳ hs_appointment_namestringAppointment title/name
↳ hs_appointment_startstringStart time (ISO 8601)
↳ hs_appointment_endstringEnd time (ISO 8601)
↳ hs_appointment_statusstringAppointment status (e.g., SCHEDULED)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Appointment from HubSpot

Retrieve a single appointment by ID from HubSpot

Input

ParameterTypeRequiredDescription
appointmentIdstringYesThe HubSpot appointment ID to retrieve
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNoComma-separated list of HubSpot property names to return (e.g., "hs_appointment_name,hs_appointment_start")
associationsstringNoComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Output

ParameterTypeDescription
appointmentobjectHubSpot appointment record
↳ hs_appointment_namestringAppointment title/name
↳ hs_appointment_startstringStart time (ISO 8601)
↳ hs_appointment_endstringEnd time (ISO 8601)
↳ hs_appointment_statusstringAppointment status (e.g., SCHEDULED)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
appointmentIdstringThe retrieved appointment ID
successbooleanOperation success status

Create Appointment in HubSpot

Create a new appointment in HubSpot

Input

ParameterTypeRequiredDescription
propertiesobjectYesAppointment 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"})
associationsarrayNoArray of associations to create with the appointment as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId"

Output

ParameterTypeDescription
appointmentobjectHubSpot appointment record
↳ hs_appointment_namestringAppointment title/name
↳ hs_appointment_startstringStart time (ISO 8601)
↳ hs_appointment_endstringEnd time (ISO 8601)
↳ hs_appointment_statusstringAppointment status (e.g., SCHEDULED)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
appointmentIdstringThe created appointment ID
successbooleanOperation success status

Update Appointment in HubSpot

Update an existing appointment in HubSpot by ID

Input

ParameterTypeRequiredDescription
appointmentIdstringYesThe HubSpot appointment ID to update
idPropertystringNoProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectYesAppointment properties to update as JSON object (e.g., {"hs_appointment_name": "Updated Call", "hs_appointment_start": "2024-01-15T10:00:00Z"})

Output

ParameterTypeDescription
appointmentobjectHubSpot appointment record
↳ hs_appointment_namestringAppointment title/name
↳ hs_appointment_startstringStart time (ISO 8601)
↳ hs_appointment_endstringEnd time (ISO 8601)
↳ hs_appointment_statusstringAppointment status (e.g., SCHEDULED)
↳ hubspot_owner_idstringHubSpot owner ID
↳ hs_object_idstringHubSpot object ID (same as record ID)
↳ hs_createdatestringCreation date (ISO 8601)
↳ hs_lastmodifieddatestringLast modified date (ISO 8601)
appointmentIdstringThe updated appointment ID
successbooleanOperation success status

List Carts from HubSpot

Retrieve all carts from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)
propertiesstringNoComma-separated list of HubSpot property names to return
associationsstringNoComma-separated list of object types to retrieve associated IDs for

Output

ParameterTypeDescription
cartsarrayArray of HubSpot CRM records
↳ idstringUnique record ID (hs_object_id)
↳ createdAtstringRecord creation timestamp (ISO 8601)
↳ updatedAtstringRecord last updated timestamp (ISO 8601)
↳ archivedbooleanWhether the record is archived
↳ propertiesobjectRecord properties
↳ associationsobjectAssociated records
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Cart from HubSpot

Retrieve a single cart by ID from HubSpot

Input

ParameterTypeRequiredDescription
cartIdstringYesThe HubSpot cart ID to retrieve
propertiesstringNoComma-separated list of HubSpot property names to return
associationsstringNoComma-separated list of object types to retrieve associated IDs for

Output

ParameterTypeDescription
cartobjectHubSpot CRM record
↳ idstringUnique record ID (hs_object_id)
↳ createdAtstringRecord creation timestamp (ISO 8601)
↳ updatedAtstringRecord last updated timestamp (ISO 8601)
↳ archivedbooleanWhether the record is archived
↳ propertiesobjectRecord properties
↳ associationsobjectAssociated records
cartIdstringThe retrieved cart ID
successbooleanOperation success status

List Owners from HubSpot

Retrieve all owners from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 100)
afterstringNoPagination cursor for next page of results (from previous response)
emailstringNoFilter owners by email address

Output

ParameterTypeDescription
ownersarrayArray of HubSpot owner objects
↳ idstringOwner ID
↳ emailstringOwner email address
↳ firstNamestringOwner first name
↳ lastNamestringOwner last name
↳ userIdnumberAssociated user ID
↳ teamsarrayTeams the owner belongs to
↳ idstringTeam ID
↳ namestringTeam name
↳ createdAtstringCreation date (ISO 8601)
↳ updatedAtstringLast updated date (ISO 8601)
↳ archivedbooleanWhether the owner is archived
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

List Marketing Events from HubSpot

Retrieve all marketing events from HubSpot account with pagination support

Input

ParameterTypeRequiredDescription
limitstringNoMaximum number of results per page (max 100, default 10)
afterstringNoPagination cursor for next page of results (from previous response)

Output

ParameterTypeDescription
eventsarrayArray of HubSpot marketing event objects
↳ objectIdstringUnique event ID (HubSpot internal)
↳ eventNamestringEvent name
↳ eventTypestringEvent type
↳ eventStatusstringEvent status
↳ eventDescriptionstringEvent description
↳ eventUrlstringEvent URL
↳ eventOrganizerstringEvent organizer
↳ startDateTimestringStart date/time (ISO 8601)
↳ endDateTimestringEnd date/time (ISO 8601)
↳ eventCancelledbooleanWhether event is cancelled
↳ eventCompletedbooleanWhether event is completed
↳ registrantsnumberNumber of registrants
↳ attendeesnumberNumber of attendees
↳ cancellationsnumberNumber of cancellations
↳ noShowsnumberNumber of no-shows
↳ externalEventIdstringExternal event ID
↳ createdAtstringCreation date (ISO 8601)
↳ updatedAtstringLast updated date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

Get Marketing Event from HubSpot

Retrieve a single marketing event by ID from HubSpot

Input

ParameterTypeRequiredDescription
eventIdstringYesThe HubSpot marketing event objectId to retrieve

Output

ParameterTypeDescription
eventobjectHubSpot marketing event
↳ objectIdstringUnique event ID (HubSpot internal)
↳ eventNamestringEvent name
↳ eventTypestringEvent type
↳ eventStatusstringEvent status
↳ eventDescriptionstringEvent description
↳ eventUrlstringEvent URL
↳ eventOrganizerstringEvent organizer
↳ startDateTimestringStart date/time (ISO 8601)
↳ endDateTimestringEnd date/time (ISO 8601)
↳ eventCancelledbooleanWhether event is cancelled
↳ eventCompletedbooleanWhether event is completed
↳ registrantsnumberNumber of registrants
↳ attendeesnumberNumber of attendees
↳ cancellationsnumberNumber of cancellations
↳ noShowsnumberNumber of no-shows
↳ externalEventIdstringExternal event ID
↳ createdAtstringCreation date (ISO 8601)
↳ updatedAtstringLast updated date (ISO 8601)
eventIdstringThe retrieved marketing event ID
successbooleanOperation success status

List Lists from HubSpot

Search and retrieve lists from HubSpot account

Input

ParameterTypeRequiredDescription
querystringNoSearch query to filter lists by name. Leave empty to return all lists.
countstringNoMaximum number of results to return (default 20, max 500)
offsetstringNoPagination offset for next page of results (use the offset value from previous response)

Output

ParameterTypeDescription
listsarrayArray of HubSpot list objects
↳ listIdstringList ID
↳ namestringList name
↳ objectTypeIdstringObject type ID (e.g., 0-1 for contacts)
↳ processingTypestringProcessing type (MANUAL, DYNAMIC, SNAPSHOT)
↳ processingStatusstringProcessing status (COMPLETE, PROCESSING)
↳ listVersionnumberList version number
↳ createdAtstringCreation date (ISO 8601)
↳ updatedAtstringLast updated date (ISO 8601)
pagingobjectPagination information for fetching more results
↳ afterstringCursor for next page of results
↳ linkstringLink to next page
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
↳ totalnumberTotal number of lists matching the query
successbooleanOperation success status

Get List from HubSpot

Retrieve a single list by ID from HubSpot

Input

ParameterTypeRequiredDescription
listIdstringYesThe HubSpot list ID to retrieve

Output

ParameterTypeDescription
listobjectHubSpot list
↳ listIdstringList ID
↳ namestringList name
↳ objectTypeIdstringObject type ID (e.g., 0-1 for contacts)
↳ processingTypestringProcessing type (MANUAL, DYNAMIC, SNAPSHOT)
↳ processingStatusstringProcessing status (COMPLETE, PROCESSING)
↳ listVersionnumberList version number
↳ createdAtstringCreation date (ISO 8601)
↳ updatedAtstringLast updated date (ISO 8601)
listIdstringThe retrieved list ID
successbooleanOperation success status

Create List in HubSpot

Create a new list in HubSpot. Specify the object type and processing type (MANUAL or DYNAMIC)

Input

ParameterTypeRequiredDescription
namestringYesName of the list
objectTypeIdstringYesObject type ID (e.g., "0-1" for contacts, "0-2" for companies)
processingTypestringYesProcessing type: "MANUAL" for static lists or "DYNAMIC" for active lists

Output

ParameterTypeDescription
listobjectHubSpot list
↳ listIdstringList ID
↳ namestringList name
↳ objectTypeIdstringObject type ID (e.g., 0-1 for contacts)
↳ processingTypestringProcessing type (MANUAL, DYNAMIC, SNAPSHOT)
↳ processingStatusstringProcessing status (COMPLETE, PROCESSING)
↳ listVersionnumberList version number
↳ createdAtstringCreation date (ISO 8601)
↳ updatedAtstringLast updated date (ISO 8601)
listIdstringThe created list ID
successbooleanOperation success status

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

These run on a schedule (polling-based) — they check for new data rather than receiving push notifications.

HubSpot CRM Trigger

Triggers when HubSpot CRM records (contacts, companies, deals, tickets, custom objects) are created or updated, or when contacts join a list

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesConnect a HubSpot account so Sim can poll your CRM on your behalf.
objectTypestringYesWhat you want to watch.
customObjectTypeIdstringNoHubSpot custom object type ID (e.g. "2-12345"). Find it in HubSpot Settings → Objects → Custom Objects.
listIdstringNoThe HubSpot list to watch for new members.
eventTypestringNoCreated fires once per new record. Updated fires on any modification. Property Changed fires only when the chosen property changes value.
targetPropertyNamestringNoFires only when this specific property changes value on a record.
propertiesstringNoProperties to include on each record. Leave empty to use sensible defaults. Sim always includes the timestamps it needs internally.
pipelineIdstringNoRestrict to a single pipeline.
stageIdstringNoRestrict to a single stage within the selected pipeline.
ownerIdstringNoRestrict to records owned by a specific HubSpot user.
filtersstringNoJSON 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.
maxRecordsPerPollstringNoSoft cap on records emitted per poll (default 50, max 1000). Excess rolls over to the next poll.

Output

ParameterTypeDescription
objectTypestringHubSpot object type (contact, company, deal, ticket, custom object id, or list_membership)
eventTypestringEvent type (created, updated, property_changed, or joined)
objectIdstringHubSpot ID of the affected record (or contact id for list memberships)
occurredAtstringISO timestamp of when the change happened in HubSpot
propertiesjsonHubSpot 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.
createdAtstringISO timestamp when the record was created in HubSpot
updatedAtstringISO timestamp when the record was last updated in HubSpot
archivedbooleanWhether the record is archived
propertyNamestringName of the property that changed (property_changed events only)
propertyValuestringNew value of the changed property (property_changed events only)
previousValuestringPrevious value before the change (property_changed events only)
listIdstringHubSpot list ID (list_membership events only)
timestampstringISO timestamp when Sim emitted the event
HexHubSpot Private App Tokens

On this page

Usage Instructions
Actions
Get Users from HubSpot
Input
Output
List Contacts from HubSpot
Input
Output
Get Contact from HubSpot
Input
Output
Create Contact in HubSpot
Input
Output
Update Contact in HubSpot
Input
Output
Search Contacts in HubSpot
Input
Output
List Companies from HubSpot
Input
Output
Get Company from HubSpot
Input
Output
Create Company in HubSpot
Input
Output
Update Company in HubSpot
Input
Output
Search Companies in HubSpot
Input
Output
List Deals from HubSpot
Input
Output
Get Deal from HubSpot
Input
Output
Create Deal in HubSpot
Input
Output
Update Deal in HubSpot
Input
Output
Search Deals in HubSpot
Input
Output
List Tickets from HubSpot
Input
Output
Get Ticket from HubSpot
Input
Output
Create Ticket in HubSpot
Input
Output
Update Ticket in HubSpot
Input
Output
Search Tickets in HubSpot
Input
Output
List Notes from HubSpot
Input
Output
Get Note from HubSpot
Input
Output
Create Note in HubSpot
Input
Output
Search Notes in HubSpot
Input
Output
List Emails from HubSpot
Input
Output
Get Email from HubSpot
Input
Output
Create Email in HubSpot
Input
Output
Search Emails in HubSpot
Input
Output
Get Properties from HubSpot
Input
Output
List Associations in HubSpot
Input
Output
Create Association in HubSpot
Input
Output
Delete Association in HubSpot
Input
Output
Get Association Labels from HubSpot
Input
Output
Delete Contact from HubSpot
Input
Output
Delete Company from HubSpot
Input
Output
Delete Deal from HubSpot
Input
Output
Delete Ticket from HubSpot
Input
Output
Delete Line Item from HubSpot
Input
Output
Search Line Items in HubSpot
Input
Output
Search Quotes in HubSpot
Input
Output
Get List Members from HubSpot
Input
Output
Add List Members in HubSpot
Input
Output
Remove List Members in HubSpot
Input
Output
List Line Items from HubSpot
Input
Output
Get Line Item from HubSpot
Input
Output
Create Line Item in HubSpot
Input
Output
Update Line Item in HubSpot
Input
Output
List Quotes from HubSpot
Input
Output
Get Quote from HubSpot
Input
Output
List Appointments from HubSpot
Input
Output
Get Appointment from HubSpot
Input
Output
Create Appointment in HubSpot
Input
Output
Update Appointment in HubSpot
Input
Output
List Carts from HubSpot
Input
Output
Get Cart from HubSpot
Input
Output
List Owners from HubSpot
Input
Output
List Marketing Events from HubSpot
Input
Output
Get Marketing Event from HubSpot
Input
Output
List Lists from HubSpot
Input
Output
Get List from HubSpot
Input
Output
Create List in HubSpot
Input
Output
Triggers
HubSpot CRM Trigger
Configuration
Output