HubSpot API explained - HubSpot API: How to start?
date
May 21, 2021 04:33 AM
author
slug
hubspot-api-explained
status
Published
tags
HubSpot
summary
How to Use HubSpot API? → HubSpot’s developer platform is a core part of our mission to empower organizations to grow better. Our APIs are designed to enable teams of any shape or size to build robust integrations that help them customize and get the most value out of HubSpot.
type
Post
HubSpot API reference documentation
All HubSpot APIs are built using REST conventions and designed to have a predictable URL structure. They use many standard HTTP features, including methods ( POST , GET , PUT , DELETE ) and error response codes. All HubSpot API calls are made under https://api.hubapi.com and all responses return standard JSON.
How to Use HubSpot API
Quick links
- Use a test account to install your app and test API calls
- Stay up-to-date by subscribing to the Changelog
- Join the conversation or ask questions in HubSpot’s developer community forums
- Become a member of our developer Slack community
Video Tutorials
Developer Documents
API developer guides & resources
HubSpot's APIs, which you can find the reference documentation here, allow you to build a functional app or integration quickly and easily. Here's an overview of what you'll need to use them.
Building apps
Before HubSpot users can start installing your app, you'll need to get set up in your developer account. From there, you can create an app, configure OAuth, and create a test environment. Start building now.
Authentication
Most HubSpot API endpoints support both OAuth and API keys. However, if you want to list your app in our App Marketplace or have multiple users install it, you must use OAuth.
Usage and limits
Learn about our usage guidelines, rate limits, and how to check your API call usage.
App Partners and the App Marketplace
Review app listing requirements and create your app listing.
Learn to use APIs and build apps on HubSpot Academy
Learn more about the HubSpot APIs, developer accounts, and how to start making calls using both OAuth and API keys with these short (and free!) HubSpot Academy videos.
Guides & resources
HubSpot’s developer platform is a core part of our mission to empower organizations to grow better. Our APIs are designed to enable teams of any shape or size to build robust integrations that help them customize and get the most value out of HubSpot.
All HubSpot APIs are built using REST conventions and designed to have a predictable URL structure. They use many standard HTTP features, including methods (
POST, GET, PUT, DELETE) and error response codes. All HubSpot API calls are made under https://api.hubapi.com and all responses return standard JSON.Setting up
The best way to start building integrations with HubSpot is to create a developer account. There are several reasons for this: A developer account is where you create HubSpot apps, each authenticated with OAuth and provided with a configurable set of features and permissions. You can also use your developer account to create test accounts, monitor app status and performance, or publish apps to the HubSpot App Marketplace.
Related: What’s the relationship between a developer account and a test account?
Client libraries
Client libraries are designed to help you interact with the HubSpot APIs with less friction. They are written in several different languages and help bridge the gap between your application and HubSpot’s APIs. They take away the need to know the exact URL and HTTP method to use for each API call among other things leaving you more time to focus on making your application. Learn more about our client libraries here
API documentation
HubSpot’s API documentation is split into two sections: reference docs and integration guides.
Reference docs
All API reference docs include an overview section and an endpoint section. The API overview includes a brief summary of its functionality, use cases, and any special considerations for creating an integration. The endpoints section lists each endpoint, its parameters, and request examples in multiple languages.
Once you’ve configured your app’s auth settings in your developer account, you can use Postman or make test calls right from an endpoint reference page.
Integration guides
If you want to learn the fundamentals of HubSpot’s platform or see an example before making your first API call, you can find sample apps and tutorials as well as detailed information about developer accounts, working with OAuth, API rate limits, and more in our Integration Guides section.
Related: Learn more about authentication methods or OAuth.
Getting listed
When you’re ready to share your app with the world and become an app partner, read our listing and certification requirements. After that, you can create and manage your App Marketplace listing right from your developer account.
Support and community resources
Get your questions answered, make connections, and share your insights by joining HubSpot’s growing developer community forums and Slack community. These forums are a great place to make your voice heard — community feedback is incredibly important to us and our ongoing efforts to improve HubSpot’s developer experience.
You can also stay up to date on new features, announcements, and important changes by subscribing to the Changelog blog.
Building on the CMS
Looking to build a website, blog, landing page, lightweight app, or an email? Head over to our CMS developer docs.