👋 Introduction

Welcome to the HubSpot Public API Qodex collections. This workspace serves as a source for end users to access the latest public HubSpot API collections to help end-users test and onboard with our services. This workspace contains two tabs: [Collections] The collections tab allows us to group requests. [APIs] This APIs tab contains the single source of truth for the API. Each API includes the API definition, collections, documentation, and tests. This allows us to sync the API in Qodex with a GitHub repository internally at HubSpot, ensuring the schema is up-to-date for our user base. If you're new to Qodex, we suggest referencing [Qodex's basic documentation] to familiarize yourself with the tool.

🚀 Getting started with this workspace

This workspace includes a series of APIs and collections, each corresponding to a specific HubSpot product or feature such as 'CRM,' 'CMS,' 'Conversations,' and more. These collections are derived from each public API's HubSpot OpenAPI Specification (OAS). To ensure that our API collections are accurate and reflect the latest internal schema changes, we suggest you watch this workspace for any updates and create a fork from the API tab by selecting the API you wish to work with. Please take a look at the instructions below or watch this demonstration.

Select the API and latest version you wish to access. You can reference [the Qodex documentation] to familiarize yourself with where to reference the API-published versions within the Qodex UI.

Provide a name for the collection you are forking and add it to your own workspace. Make sure to select the notifications checkbox.

Whenever there has been an update made to the collection you forked, you can [pull] the latest changes within the Qodex UI.

To learn more about Qodex forking, please reference [the Qodex documentation]

📝 Qodex collection update log

To reference changes to API definitions and collections, please refer to the published API log.
You can access this by click on the API, the navigating to the Recent Version section to ensure you have the most up-to-date API schema depending on which version was forked. Published%20API%20versions

Create an App

Apps enable you to authenticate API calls to your HubSpot account, subscribe to events with webhooks, and extend the HubSpot UI, such as with custom cards. HubSpot offers several types of apps and extensions depending on your integration's needs. Below are the type of apps you can build with HubSpot. Private app - these are best suited for a single purpose and utilize an access token. Public app - these are best suited when needing to be utilized by multiple accounts and are authenticated with OAuth.

🔑 Authorization

There are two ways to authenticate calls to HubSpot's APIs: OAuth and private app access tokens. Please review our documentation to learn more about each method and how to include it in your code for authorization. If you were using an API key to authenticate before, you could learn how to migrate to using a private app access token instead.

OAuth

To make a request using OAuth, include the OAuth access token in the authorization header:

/~curl --header "Authorization: Bearer C4d***sVq" 
https://api.hubapi.com/crm/v3/objects/contacts?limit=10&archived=false

Check out this demo using Qodex with OAuth to learn more.

Private app access tokens

Similar to OAuth, to make a request using a private app access token, include the token in the authorization header:

/~curl --header "Authorization: Bearer ***-***-*********-****-****-****-************" 
https://api.hubapi.com/crm/v3/objects/contacts?limit=10&archived=false

Configure Scopes

Configure the required scopes and permissions for your app.

Param Reference

Variable	Description
`baseUrl`	The base URL for all requests: `https://api.hubapi.com/` Please refer to the API documentation, Endpoint tab, to confirm the endpoint URL

🛟 Help and support

If you have any questions or suggestions, please don't hesitate to reach out depending on the issue and follow these instructions below:

If you have any questions or feedback regarding the API documentation or API functionality, you can find guidance on how to seek help with HubSpot, here or reference our API documentation.
To stay up-to-date with HubSpot API changes, and subscribe to the HubSpot Developer Changelog.
In case you have any questions or concerns related to HubSpot's Qodex workspace, submit your feedback or questions via this form.