There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Developers

API Docs
Changelog
Community
Get Listed
Create an Account

Overview
- API overview
- API usage guidelines
- Listing your app
- Working within API rate limits
- Get account details
Developer Preview
- Developer preview overview
- Get secondary email addresses
- Add a secondary email address
- Update a secondary email address
- Delete a secondary email address
Authentication
- Authentication overview
OAuth 2.0
- OAuth 2.0 overview
- OAuth 2.0 Quickstart Guide
- OAuth 2.0 scopes
- Initiating an OAuth connection
- Get access and refresh tokens
- Refresh access token
- Get access token information
- Get refresh token information
- Delete refresh token
- Using OAuth 2.0 access tokens
CRM Integration Guide
FAQ
- FAQ overview
- Testing the HubSpot APIs
- API error responses
- Timestamp formatting
- CORS / AJAX support
- vidOffset and timeOffset
- Getting all contact properties
- Multiple values for checkbox
- Manipulating forms with jQuery
- How do I send transactional emails?
- How are email addresses validated?
- Contact and Form Limits
- Tracking lawful basis of processing in HubSpot
Using the developer tools
- Developer tools overview
- How do I create an app in HubSpot?
- How do I find the app ID for a HubSpot app?
- Installing an app
- How do I create a test account?
- Using app request monitoring
- Prerequisites for Integrations Platform API
- Developer API keys
- Validating requests from HubSpot
- Sample apps
Analytics API
- Analytics API Overview
- Get analytics data breakdowns
- Get analytics data for specific objects
- Get analytics data for HubSpot hosted content
- Check for the existence of analytics data for an object type
- Get Events
- Get a Group of Events by ID
- Get all analytics views
Calendar API
- Create task
Companies API
- Companies overview
- Create a company
- Update a company
- Update a group of companies
- Delete a company
- Get all companies
- Get recently modified companies
- Get recently created companies
- Search for companies by domain
- Get a company
- Get contacts of a company
- Get contacts IDs of a company
- Add contact to company
- Remove contact from company
Company Properties API
- Company properties overview
- Get all company properties
- Get a company property
- Create a company property
- Update a company property
- Delete a company property
- Get company property groups
- Create a company property group
- Update a company property group
- Delete a company property group
Contacts API
- Contacts overview
- Create a contact
- Update a contact
- Update a contact by email
- Create or update a contact
- Create or update a group of contacts
- Delete a contact
- Embed a contact in an external system
- Get all contacts
- Get recently modified contacts
- Get recently created contacts
- Get contact by ID
- Get group of contacts by ID
- Get contact by email
- Get group of contacts by email
- Get contact by user token
- Get a batch of contacts by user token
- Search for contacts
- Merge contacts
- Get lifecycle stage metrics for contacts
- Get Contacts Statistics
Contact Lists API
- Contact lists overview
- Create a contact list
- Get contact lists
- Get a contact list by ID
- Update a contact list
- Delete a contact list
- Get a group of contact lists
- Get static contact lists
- Get dynamic contact lists
- Get contacts in a list
- Get recently added contacts in a list
- Add contact to list
- Remove contact from list
Contact Properties API
- Contact properties overview
- Get all properties
- Get a contact property
- Create a new property
- Update a property
- Delete a property
- Get property groups
- Get property group details
- Create a property group
- Update a property group
- Delete a property group
Conversations Live Chat Widget API
- Conversations live chat widget overview
- Load the chat widget
- Refresh the chat widget
- Using chat widget events
- Check the widget status
- Close the chat widget
- Remove the chat widget
- Open the chat widget
- Set conversation settings
- Execute functions when the widget loads
CMS Blog API
- List blogs
- Get a blog by ID
- List blog revisions
- Get a blog revision
CMS Blog Authors API
- List blog authors
- Search blog authors
- Get blog author
- Create blog author
- Update blog author
- Delete blog author
CMS Blog Comments API
- List comments
- Get comment
- Create new comment
- Delete comment
- Restore deleted comment
CMS Blog Post API
- List blog posts
- Get a blog post by ID
- Create a new blog post
- Update the blog post
- Delete the blog post
- Clone the blog post
- Publish or unpublish a blog post
- Get the current contents of the auto-save buffer
- Update the auto-save buffer
- Determine if the auto-save buffer differs from the live blog post
- Validate the auto-save buffer version of the blog post
- Copy the contents of the auto-save buffer into the live blog post
- Restore a previously deleted blog post
- List blog post revisions
- Get a previous blog post revision
- Restore a previous blog post revision
CMS Blog Topics API
- List blog topics
- Search blog topics
- Get blog topic
- Create blog topic
- Update blog topic
- Delete blog topic
- Merge blog topics
CMS Domains API
- Get domains
- Get a domain by ID
CMS Files API
- Upload a new file
- List metadata for all files
- Upload a replacement file
- Mark a file as deleted
- Get file metadata
- Archive a file
- Hard delete a file and related items
- Update the access of a group of files
- Check the status of a file access update task
- Get a signed URL for a private file
- Move a file
- Create a folder
- List folder metadata
- Delete a folder
- Get the folder by ID
- Move or rename a folder
CMS HubDB API
- HubDB API overview
- Get all tables
- Get details for a specific table
- Create a new table
- Clone a table
- Update a table
- Delete a table
- Get table rows
- Add a new row to a table
- Clone a row
- Update a row
- Delete a row
- Update a row cell
- Delete a cell from a row
- Publish the draft table to live
- Revert the draft data for a table
- Import a CSV file
CMS Layouts API
- List layouts
- Get the layout by ID
- Gets the current contents of the auto-save buffer
- Determine if the auto-save buffer differs from the live layout
- List previous versions of the layout
- Get the previous version of the layout
CMS Page Publishing API
- Create a new page
- List pages
- Update a page
- Delete a page
- Get a page by ID
- Clone a page
- Publish or unpublish a page
- Get the current contents of the auto-save buffer
- Update the auto-save buffer
- Determine if the auto-save buffer differs from the live page
- Copy the contents of the auto-save buffer into the live page
- Validate the auto-save buffer version of the page
- Restore a previously deleted page
- List previous versions of a page
- Restore a previous version of a page
CMS Site Search API
- Search for Content
- Get indexed properties
CMS Templates API
- Create a new template
- List templates
- Update the template
- Delete the template
- Get the template by ID
- Updates the auto-save buffer
- Gets the current contents of the auto-save buffer
- Determine if the auto-save buffer differs from the live template
- Copies the contents of the auto-save buffer into the live template.
- Restores a previously deleted template
- List previous versions of the template
- Get the previous version of the template
- Restore a previous version of the template
CMS URL Mappings API
- List URL mappings
- Get the URL mapping by ID
- Create a new URL mapping
- Update the URL mapping
- Delete the URL mapping
CRM Associations API
- CRM associations overview
- Get associations for CRM object
- Create CRM association
- Batch create CRM associations
- Delete CRM association
- Batch delete CRM associations
CRM Extensions API
- CRM Extensions overview
- Extension property types
- Create object type
- View an object type
- Modify an object type
- Delete an object type
CRM Object Properties API
- CRM object properties overview
- Get all object properties
- Create a new object property
- Update an object property
- Delete an object property
- Get all object property groups
- Create object property group
- Update object property group
- Delete an object property group
CRM Pipelines API
- CRM Pipelines Overview
- Get all pipelines for a specified object type
- Create new pipeline
- Update an existing pipeline
- Delete an existing pipeline
Deals API
- Deals overview
- Create a deal
- Update a deal
- Update a group of deals
- Get all deals
- Get recently modified deals
- Get recently created deals
- Delete a deal
- Get a deal
- Associate deal
- Remove association of deal
Deal Properties API
- Deal properties overview
- Create a deal property
- Update a deal property
- Delete a deal property
- Get all deal properties
- Get a deal property
- Create a deal property group
- Update a deal property group
- Delete a deal property group
- Get deal groups
- Get a deal group
Email Subscription API
- Email subscription overview
- Get subscription type definitions
- View subscriptions timeline
- View subscription status of email address
- Update subscription status of email address
Email Events API
- Email events overview
- Get all campaign IDs for a portal
- Get campaign IDs with recent activity for a portal
- Get campaign data for a particular Campaign
- Get event data for a campaign or recipient
- Get event data for a specific event
Engagements API
- Engagements overview
- Create an engagement
- Update an engagement
- Get an engagement
- Get all engagements
- Get recent engagements
- Delete an engagement
- Associate engagement with CRM object
- Get call dispositions
Events API
- Get Events
- Get an Event by ID
- Get a Group of Events by ID
Forms API
- Forms overview
- Submit form data
- Submit form data (Supporting Authentication)
- Get forms
- Get form
- Get submissions for a form
- Get a file uploaded via form field
- Create a form
- Update a form
- Delete a form
- Get form fields
- Get a form field
- Customizing the embed code
- Using Global Form Events
Line Items API
- Line items overview
- Get all line items
- Get line item by ID
- Get a group of line items by ID
- Create a line item
- Create a group of line items
- Update a line item
- Update a group of line items
- Delete a line item
- Delete a group of line items
- Get a log of changes for line items
Marketing Email API
- Marketing email overview
- Get all marketing emails
- Get a marketing email
- Create a marketing email
- Update a marketing email
- Clone a marketing email
- Delete a marketing email
- Get revisions of a marketing email
- Restore a deleted marketing email
- Determine the buffer of a marketing email
- Get the statistics for a marketing email
- Get all marketing email statistics
Owners API
- Owners overview
- Get Owners
- Get an owner
Products API
- Products overview
- Get all products
- Get product by ID
- Get a group of products by ID
- Create a product
- Create a group of products
- Update a product
- Update a group of products
- Delete a product
- Delete a group of products
- Get a log of changes for products
Social Media API
- Get publishing channels
- Get broadcast messages
- Get a broadcast message
- Create a broadcast message
- Cancel a broadcast message
Tickets API
- Tickets overview
- Get all tickets
- Get ticket by ID
- Get a group of tickets by ID
- Create a ticket
- Create a group of tickets
- Update a ticket
- Update a group of tickets
- Delete a ticket
- Delete a group of tickets
- Get a log of changes for tickets
Timeline API
- Timeline API overview
- Details for timeline event templates
- Create or update timeline event
- Get the details for an existing event
- Create or update a group of timeline events
- Get timeline event types
- Get timeline event type by id
- Create new timeline event type
- Update timeline event type
- Delete timeline event type
- Get properties for event type
- Create property for event type
- Update property for event Type
- Delete property for event type
Tracking Code API
- Tracking code overview
- Track page view
- Identify a visitor
- Events Javascript API
- Events HTTP API
- Get cross-domain linking parameters
- Reapply analytics event handlers
Transactional Email API
- Overview
- SMTP API
- List SMTP tokens
- Create SMTP token
- Token password reset
- Single-send API
Workflows API
- Workflows overview
- Workflow extensions
- Get all workflows
- Get a specific workflow
- Enroll a contact into a workflow
- Create a workflow
- Delete a workflow
- Unenroll (remove) a contact from a workflow
- Current enrollments
- Get performance stats for a workflow
- Using webhooks in workflows
Webhooks API
- Webhooks overview