Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Developer Tools
Retrieve the current ecommerce settings.
There's a new version of the HubSpot API
As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Developer Tools
Required Parameters | How to use | Description |
---|---|---|
API Key | hapikey= | The API key ( Note: If you are working with an installed app using OAuth, you must use the Developer |
App ID | &appId= Used in the request URL |
The ID of the app, created inside your HubSpot Developer portal. Required if you are retrieving the settings for an installed app. |
Optional Parameters | How to use | Description |
---|---|---|
Show Provided Mappings | showProvidedMappings= | Boolean to indicate if the response should contain the HubSpot defined mappings. Defaults to false |