Skip to content
HubSpot Developer Changelog

Sunset: Replacing api-catalog-public/v1/apis Endpoint


Starting November 11th, 2024, we are deprecating the api-catalog-public/v1/apis endpoint, which will be replaced by the new public/api/spec/v1/specs endpoint. The new endpoint provides a different response format to support HubSpot API versioning and will continue to link to the same HubSpot public OpenAPI specs. If you're currently referencing our OpenAPI specs, we encourage you to migrate to the new endpoint as we plan to retire the old service.

What's changing?

We are deprecating the existing api-catalog-public/v1/apis endpoint and replacing it with a new one.

  • Affected Endpoint: api-catalog-public/v1/apis
  • Replacement Endpoint: public/api/spec/v1/specs

The replacement endpoint will include a new response format. Here is a truncated version of the response:

// Example of public/api/spec/v1/specs response { "results": [ { "name": "Account Info", "group": "Account", "versions": [ { "version": 3, "stage": "LATEST", "requirements": { "marketing": "FREE", "sales": "FREE", "service": "FREE", "cms": "FREE" }, "introduction": "Use the account information API to retrieve login and security history for your account, as well as usage data for a public app.", "useCase": "Your security team wants deeper insight into which internal users are accessing your HubSpot account data and you need to provide the associated activity data.", "openApi": "https://private.hubapi.com/public/api/spec/v1/specs/Account/Account Info/versions/144923" } ] }, { "name": "Audit Logs", "group": "Account", "versions": [ { "version": 3, "stage": "LATEST", "requirements": { "marketing": "FREE", "sales": "FREE", "service": "FREE", "cms": "FREE" }, "introduction": "The account activity API allows you to retrieve login history and security activity for your HubSpot account.", "useCase": "You want to build an internal tool for your compliance team to regularly monitor the activity of employees in your company accessing data in your HubSpot account.", "openApi": "https://private.hubapi.com/public/api/spec/v1/specs/Account/Audit Logs/versions/144923" } ] }, { "name": "Oauth", "group": "Auth", "versions": [ { "version": 1, "stage": "LATEST", "requirements": { "marketing": "FREE", "sales": "FREE", "service": "FREE", "cms": "FREE" }, "introduction": "", "useCase": "", "openApi": "https://private.hubapi.com/public/api/spec/v1/specs/Auth/Oauth/versions/155908" } ] } ] }

For users currently leveraging the api-catalog-public/v1/apis endpoint, we strongly urge you to migrate to the replacement endpoint before the sunset date. 

Reason for Change

This update is being implemented to support multiple versions of HubSpot APIs.

When is it happening?

This change goes into effect on November 11th, 2024.

Questions or comments? Join us in the developer forums.