AptlyStar

HubSpot

Interact with HubSpot CRM or trigger workflows from HubSpot events

Nutzungsanweisungen

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.

Tools

hubspot_get_users

Retrieve users from HubSpot account via the CRM users object

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 10)
afterstringNeinPagination cursor for next page of results (from previous response)
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "hs_email,hs_given_name,hs_family_name")

Ausgabe

ParameterTypBeschreibung
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
metadataobjectResponse metadata
↳ totalReturnednumberNumber of records returned in this response
↳ hasMorebooleanWhether more records are available
successbooleanOperation success status

hubspot_list_contacts

Retrieve all contacts from HubSpot account with pagination support

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 100)
afterstringNeinPagination cursor for next page of results (from previous response)
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "email,firstname,lastname,phone")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "companies,deals")

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_contact

Retrieve a single contact by ID or email from HubSpot

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_contact

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

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_update_contact

Update an existing contact in HubSpot by ID or email

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_search_contacts

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

Eingabe

ParameterTypErforderlichBeschreibung
filterGroupsarrayNeinArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNeinArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNeinSearch query string to match against contact name, email, and other text fields
propertiesarrayNeinArray of HubSpot property names to return (e.g., ["email", "firstname", "lastname", "phone"])
limitnumberNeinMaximum number of results to return (max 100)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_companies

Retrieve all companies from HubSpot account with pagination support

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 100)
afterstringNeinPagination cursor for next page of results (from previous response)
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "name,domain,industry")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,deals")

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_company

Retrieve a single company by ID or domain from HubSpot

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_company

Create a new company in HubSpot

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_update_company

Update an existing company in HubSpot by ID or domain

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_search_companies

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

Eingabe

ParameterTypErforderlichBeschreibung
filterGroupsarrayNeinArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNeinArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNeinSearch query string to match against company name, domain, and other text fields
propertiesarrayNeinArray of HubSpot property names to return (e.g., ["name", "domain", "industry"])
limitnumberNeinMaximum number of results to return (max 100)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_deals

Retrieve all deals from HubSpot account with pagination support

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_deal

Retrieve a single deal by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
dealIdstringJaThe HubSpot deal ID to retrieve
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "dealname,amount,dealstage")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_deal

Create a new deal in HubSpot. Requires at least a dealname property

Eingabe

ParameterTypErforderlichBeschreibung
propertiesobjectJaDeal properties as JSON object. Must include dealname (e.g., {"dealname": "New Deal", "amount": "5000", "dealstage": "appointmentscheduled"})
associationsarrayNeinArray of associations to create with the deal as JSON. Each object should have "to.id" and "types" array with "associationCategory" and "associationTypeId"

Ausgabe

ParameterTypBeschreibung
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

hubspot_update_deal

Update an existing deal in HubSpot by ID

Eingabe

ParameterTypErforderlichBeschreibung
dealIdstringJaThe HubSpot deal ID to update
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectJaDeal properties to update as JSON object (e.g., {"amount": "10000", "dealstage": "closedwon"})

Ausgabe

ParameterTypBeschreibung
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

hubspot_search_deals

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

Eingabe

ParameterTypErforderlichBeschreibung
filterGroupsarrayNeinArray 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"
sortsarrayNeinArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNeinSearch query string to match against deal name and other text fields
propertiesarrayNeinArray of HubSpot property names to return (e.g., ["dealname", "amount", "dealstage"])
limitnumberNeinMaximum number of results to return (max 200)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_tickets

Retrieve all tickets from HubSpot account with pagination support

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_ticket

Retrieve a single ticket by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
ticketIdstringJaThe HubSpot ticket ID to retrieve
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "subject,content,hs_ticket_priority")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_ticket

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

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_update_ticket

Update an existing ticket in HubSpot by ID

Eingabe

ParameterTypErforderlichBeschreibung
ticketIdstringJaThe HubSpot ticket ID to update
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectJaTicket properties to update as JSON object (e.g., {"subject": "Updated subject", "hs_ticket_priority": "HIGH"})

Ausgabe

ParameterTypBeschreibung
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

hubspot_search_tickets

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

Eingabe

ParameterTypErforderlichBeschreibung
filterGroupsarrayNeinArray 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"
sortsarrayNeinArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNeinSearch query string to match against ticket subject and other text fields
propertiesarrayNeinArray of HubSpot property names to return (e.g., ["subject", "content", "hs_ticket_priority"])
limitnumberNeinMaximum number of results to return (max 200)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_notes

Retrieve all notes from HubSpot account with pagination support

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_note

Retrieve a single note by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
noteIdstringJaThe HubSpot note ID to retrieve
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "hs_note_body,hs_timestamp,hubspot_owner_id")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_note

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

Eingabe

ParameterTypErforderlichBeschreibung
propertiesobjectJaNote 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"}
associationsarrayNeinArray 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)

Ausgabe

ParameterTypBeschreibung
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

hubspot_search_notes

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

Eingabe

ParameterTypErforderlichBeschreibung
filterGroupsarrayNeinArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNeinArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNeinSearch query string to match against note text fields
propertiesarrayNeinArray of HubSpot property names to return (e.g., ["hs_note_body", "hs_timestamp", "hubspot_owner_id"])
limitnumberNeinMaximum number of results to return (max 100)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_emails

Retrieve all email engagements from HubSpot account with pagination support

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_email

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

Eingabe

ParameterTypErforderlichBeschreibung
emailIdstringJaThe HubSpot email engagement ID to retrieve
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "hs_email_subject,hs_email_text,hs_timestamp")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies,deals")

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_email

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

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_search_emails

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

Eingabe

ParameterTypErforderlichBeschreibung
filterGroupsarrayNeinArray of filter groups as JSON. Each group contains "filters" array with objects having "propertyName", "operator" (e.g., "EQ", "CONTAINS_TOKEN", "GT"), and "value"
sortsarrayNeinArray of sort objects as JSON with "propertyName" and "direction" ("ASCENDING" or "DESCENDING")
querystringNeinSearch query string to match against email text fields
propertiesarrayNeinArray of HubSpot property names to return (e.g., ["hs_email_subject", "hs_email_text", "hs_timestamp"])
limitnumberNeinMaximum number of results to return (max 100)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_properties

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

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_associations

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

Eingabe

ParameterTypErforderlichBeschreibung
objectTypestringJaSource object type (e.g., "contacts", "companies", "deals")
objectIdstringJaID of the source record
toObjectTypestringJaTarget object type to list associations to (e.g., "emails", "notes", "deals")
limitstringNeinMaximum number of associated records per page (default 500)
afterstringNeinPagination cursor for next page (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_association

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

Eingabe

ParameterTypErforderlichBeschreibung
objectTypestringJaSource object type (e.g., "emails", "notes", "contacts")
objectIdstringJaID of the source record
toObjectTypestringJaTarget object type to associate to (e.g., "contacts", "companies", "deals")
toObjectIdstringJaID of the target record
associationCategorystringNeinAssociation category for a labeled association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED). Defaults to HUBSPOT_DEFINED when an association type ID is provided
associationTypeIdnumberNeinSpecific association type ID for a labeled association. Omit to create the default association for the object pair

Ausgabe

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

hubspot_list_line_items

Retrieve all line items from HubSpot account with pagination support

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_line_item

Retrieve a single line item by ID from HubSpot

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_line_item

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

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_update_line_item

Update an existing line item in HubSpot by ID

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_quotes

Retrieve all quotes from HubSpot account with pagination support

Eingabe

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

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_quote

Retrieve a single quote by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
quoteIdstringJaThe HubSpot quote ID to retrieve
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "hs_title,hs_expiration_date,hs_status")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "deals,line_items")

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_appointments

Retrieve all appointments from HubSpot account with pagination support

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 10)
afterstringNeinPagination cursor for next page of results (from previous response)
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "hs_appointment_title,hs_appointment_start_time")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Ausgabe

ParameterTypBeschreibung
appointmentsarrayArray of HubSpot appointment records
↳ hs_appointment_typestringAppointment type
↳ hs_appointment_titlestringAppointment title
↳ hs_appointment_start_timestringStart time (ISO 8601)
↳ hs_appointment_end_timestringEnd time (ISO 8601)
↳ hs_appointment_locationstringAppointment location
↳ 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

hubspot_get_appointment

Retrieve a single appointment by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
appointmentIdstringJaThe HubSpot appointment ID to retrieve
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesstringNeinComma-separated list of HubSpot property names to return (e.g., "hs_appointment_title,hs_appointment_start_time")
associationsstringNeinComma-separated list of object types to retrieve associated IDs for (e.g., "contacts,companies")

Ausgabe

ParameterTypBeschreibung
appointmentobjectHubSpot appointment record
↳ hs_appointment_typestringAppointment type
↳ hs_appointment_titlestringAppointment title
↳ hs_appointment_start_timestringStart time (ISO 8601)
↳ hs_appointment_end_timestringEnd time (ISO 8601)
↳ hs_appointment_locationstringAppointment location
↳ 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

hubspot_create_appointment

Create a new appointment in HubSpot

Eingabe

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

Ausgabe

ParameterTypBeschreibung
appointmentobjectHubSpot appointment record
↳ hs_appointment_typestringAppointment type
↳ hs_appointment_titlestringAppointment title
↳ hs_appointment_start_timestringStart time (ISO 8601)
↳ hs_appointment_end_timestringEnd time (ISO 8601)
↳ hs_appointment_locationstringAppointment location
↳ 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

hubspot_update_appointment

Update an existing appointment in HubSpot by ID

Eingabe

ParameterTypErforderlichBeschreibung
appointmentIdstringJaThe HubSpot appointment ID to update
idPropertystringNeinProperty to use as unique identifier. If not specified, uses record ID
propertiesobjectJaAppointment properties to update as JSON object (e.g., {"hs_appointment_title": "Updated Call", "hs_appointment_location": "Zoom"})

Ausgabe

ParameterTypBeschreibung
appointmentobjectHubSpot appointment record
↳ hs_appointment_typestringAppointment type
↳ hs_appointment_titlestringAppointment title
↳ hs_appointment_start_timestringStart time (ISO 8601)
↳ hs_appointment_end_timestringEnd time (ISO 8601)
↳ hs_appointment_locationstringAppointment location
↳ 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

hubspot_list_carts

Retrieve all carts from HubSpot account with pagination support

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 10)
afterstringNeinPagination cursor for next page of results (from previous response)
propertiesstringNeinComma-separated list of HubSpot property names to return
associationsstringNeinComma-separated list of object types to retrieve associated IDs for

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_cart

Retrieve a single cart by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
cartIdstringJaThe HubSpot cart ID to retrieve
propertiesstringNeinComma-separated list of HubSpot property names to return
associationsstringNeinComma-separated list of object types to retrieve associated IDs for

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_owners

Retrieve all owners from HubSpot account with pagination support

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 100)
afterstringNeinPagination cursor for next page of results (from previous response)
emailstringNeinFilter owners by email address

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_marketing_events

Retrieve all marketing events from HubSpot account with pagination support

Eingabe

ParameterTypErforderlichBeschreibung
limitstringNeinMaximum number of results per page (max 100, default 10)
afterstringNeinPagination cursor for next page of results (from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_marketing_event

Retrieve a single marketing event by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
eventIdstringJaThe HubSpot marketing event objectId to retrieve

Ausgabe

ParameterTypBeschreibung
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

hubspot_list_lists

Search and retrieve lists from HubSpot account

Eingabe

ParameterTypErforderlichBeschreibung
querystringNeinSearch query to filter lists by name. Leave empty to return all lists.
countstringNeinMaximum number of results to return (default 20, max 500)
offsetstringNeinPagination offset for next page of results (use the offset value from previous response)

Ausgabe

ParameterTypBeschreibung
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

hubspot_get_list

Retrieve a single list by ID from HubSpot

Eingabe

ParameterTypErforderlichBeschreibung
listIdstringJaThe HubSpot list ID to retrieve

Ausgabe

ParameterTypBeschreibung
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

hubspot_create_list

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

Eingabe

ParameterTypErforderlichBeschreibung
namestringJaName of the list
objectTypeIdstringJaObject type ID (e.g., "0-1" for contacts, "0-2" for companies)
processingTypestringJaProcessing type: "MANUAL" for static lists or "DYNAMIC" for active lists

Ausgabe

ParameterTypBeschreibung
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

On this page

Nutzungsanweisungen
Tools
hubspot_get_users
Eingabe
Ausgabe
hubspot_list_contacts
Eingabe
Ausgabe
hubspot_get_contact
Eingabe
Ausgabe
hubspot_create_contact
Eingabe
Ausgabe
hubspot_update_contact
Eingabe
Ausgabe
hubspot_search_contacts
Eingabe
Ausgabe
hubspot_list_companies
Eingabe
Ausgabe
hubspot_get_company
Eingabe
Ausgabe
hubspot_create_company
Eingabe
Ausgabe
hubspot_update_company
Eingabe
Ausgabe
hubspot_search_companies
Eingabe
Ausgabe
hubspot_list_deals
Eingabe
Ausgabe
hubspot_get_deal
Eingabe
Ausgabe
hubspot_create_deal
Eingabe
Ausgabe
hubspot_update_deal
Eingabe
Ausgabe
hubspot_search_deals
Eingabe
Ausgabe
hubspot_list_tickets
Eingabe
Ausgabe
hubspot_get_ticket
Eingabe
Ausgabe
hubspot_create_ticket
Eingabe
Ausgabe
hubspot_update_ticket
Eingabe
Ausgabe
hubspot_search_tickets
Eingabe
Ausgabe
hubspot_list_notes
Eingabe
Ausgabe
hubspot_get_note
Eingabe
Ausgabe
hubspot_create_note
Eingabe
Ausgabe
hubspot_search_notes
Eingabe
Ausgabe
hubspot_list_emails
Eingabe
Ausgabe
hubspot_get_email
Eingabe
Ausgabe
hubspot_create_email
Eingabe
Ausgabe
hubspot_search_emails
Eingabe
Ausgabe
hubspot_get_properties
Eingabe
Ausgabe
hubspot_list_associations
Eingabe
Ausgabe
hubspot_create_association
Eingabe
Ausgabe
hubspot_list_line_items
Eingabe
Ausgabe
hubspot_get_line_item
Eingabe
Ausgabe
hubspot_create_line_item
Eingabe
Ausgabe
hubspot_update_line_item
Eingabe
Ausgabe
hubspot_list_quotes
Eingabe
Ausgabe
hubspot_get_quote
Eingabe
Ausgabe
hubspot_list_appointments
Eingabe
Ausgabe
hubspot_get_appointment
Eingabe
Ausgabe
hubspot_create_appointment
Eingabe
Ausgabe
hubspot_update_appointment
Eingabe
Ausgabe
hubspot_list_carts
Eingabe
Ausgabe
hubspot_get_cart
Eingabe
Ausgabe
hubspot_list_owners
Eingabe
Ausgabe
hubspot_list_marketing_events
Eingabe
Ausgabe
hubspot_get_marketing_event
Eingabe
Ausgabe
hubspot_list_lists
Eingabe
Ausgabe
hubspot_get_list
Eingabe
Ausgabe
hubspot_create_list
Eingabe
Ausgabe