← Tools Reference

HubSpot

Read and write CRM contacts, companies, and deals via a Private App token

Credentials form9 toolshttps://api.hubapi.com
GET
hubspot_list_contacts
List CRM contacts, optionally selecting specific properties

/crm/v3/objects/contacts

4 parameters
ParamTypeRequiredDescription
limitintegeroptionalNumber of results per page (max 100)
afterstringoptionalPagination cursor from a previous response
propertiesstringoptionalComma-separated property names to include, e.g. 'email,firstname'
archivedbooleanoptionalReturn only archived (deleted) contacts
GET
hubspot_get_contact
Get a single CRM contact by ID (or by email/other unique idProperty)

/crm/v3/objects/contacts/{contact_id}

3 parameters
ParamTypeRequiredDescription
contact_idstringrequiredContact ID, or the value of idProperty if set
propertiesstringoptionalComma-separated property names to include, e.g. 'email,firstname'
idPropertystringoptionalProperty to look contact_id up by instead of the internal ID, e.g. 'email'
POST
hubspot_create_contact
Create a new CRM contact

/crm/v3/objects/contacts

1 parameter
ParamTypeRequiredDescription
propertiesobjectrequiredContact property name/value pairs, e.g. { email: 'a@b.com', firstname: 'Ada' }
PATCH
hubspot_update_contact
Update (patch) specific properties on an existing contact

/crm/v3/objects/contacts/{contact_id}

2 parameters
ParamTypeRequiredDescription
contact_idstringrequiredContact ID to update
propertiesobjectrequiredProperty name/value pairs to update, e.g. { lifecyclestage: 'customer' }
POST
hubspot_search_contacts
Search contacts using HubSpot's CRM search filter syntax

/crm/v3/objects/contacts/search

6 parameters
ParamTypeRequiredDescription
querystringoptionalFree-text search query across default properties
filterGroupsarrayoptionalOR'd groups of AND'd filters, e.g. [{ filters: [{ propertyName: 'email', operator: 'EQ', value: 'a@b.com' }] }]
propertiesarrayoptionalProperty names to include in each result
sortsarrayoptionalSort specs, e.g. ['-createdate']
limitintegeroptionalNumber of results per page (max 100)
afterstringoptionalPagination cursor from a previous response
GET
hubspot_list_companies
List CRM companies, optionally selecting specific properties

/crm/v3/objects/companies

3 parameters
ParamTypeRequiredDescription
limitintegeroptionalNumber of results per page (max 100)
afterstringoptionalPagination cursor from a previous response
propertiesstringoptionalComma-separated property names to include, e.g. 'name,domain'
POST
hubspot_create_company
Create a new CRM company

/crm/v3/objects/companies

1 parameter
ParamTypeRequiredDescription
propertiesobjectrequiredCompany property name/value pairs, e.g. { name: 'Acme', domain: 'acme.com' }
GET
hubspot_list_deals
List CRM deals, optionally selecting specific properties

/crm/v3/objects/deals

3 parameters
ParamTypeRequiredDescription
limitintegeroptionalNumber of results per page (max 100)
afterstringoptionalPagination cursor from a previous response
propertiesstringoptionalComma-separated property names to include, e.g. 'dealname,amount,dealstage'
POST
hubspot_create_deal
Create a new CRM deal

/crm/v3/objects/deals

1 parameter
ParamTypeRequiredDescription
propertiesobjectrequiredDeal property name/value pairs, e.g. { dealname: 'New Deal', pipeline: 'default', dealstage: 'appointmentscheduled', amount: '5000' }