For a given portal, return the list of settings in JSON format. Note: there are HubSpot-internal settings which are not exposed to the public via this method.
| Required Parameters | How to use | Description |
|---|---|---|
| HubSpot OAuth Access Token | access_token=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. |
| Optional Parameters | How to use | Description |
|---|---|---|
| Include Social Media Accounts | &sm=true - Used in the request URL | Set this parameter to true to include the social media account information for the portal. It's set to "false" by default for performance reasons. In the resulting JSON, the "appKey" field is used to name the service, e.g. Facebook, Twitter, or LinkedIn. Again, these settings are read-only and cannot be modified at this time. |
| Include Domain Names | &domains=X - Used in the request URL | Set this to true if you want to include domain information in the returned settings data. |
| Include Read Only Settings | &readOnly=X - used in the request URL | Set this to true to include all read only settings. |
Example URL: https://api.hubapi.com/settings/v1/settings?access_token=demooooo-oooo-oooo-oooo-oooooooooooo&sm=true
Example JSON output. It's displaying all of the settings, including social media settings from the HubSpot demo portal:
[
{
"name": "BG:SavedBlogID",
"value": "20326",
"portalId": 62515,
"appKey": "bloggrader",
"createdAt": 1323297705945,
"updatedAt": 0
},
{
"name": "hubspot:timezone",
"value": "Europe/London",
"portalId": 62515,
"appKey": "",
"createdAt": 1323297705945,
"updatedAt": 0
},
{
"name": "labs:trialdashpersona",
"value": "methodology",
"portalId": 62515,
"appKey": null,
"createdAt": 1323297705945,
"updatedAt": 0
},
{
"name": "labs:usedashboardplus",
"value": "show",
"portalId": 62515,
"appKey": "",
"createdAt": 1323297705945,
"updatedAt": 0
},
{
"name": "labs:usetrialdash",
"value": "true",
"portalId": 62515,
"appKey": null,
"createdAt": 1323297705945,
"updatedAt": 0
},
{
"name": "sfdc:nightly_job_successful_login",
"value": "false",
"portalId": 62515,
"appKey": "",
"createdAt": 1323297705945,
"updatedAt": 0
},
{
"name" : "LG-SKIP_PORTAL",
"value" : "true",
"portalId" : 62515,
"appKey" : "",
"createdAt" : 1327698967701,
"updatedAt" : 0
},
{
"name" : "readOnly",
"value" : [ {
"name" : "facebeezy",
"value" : null,
"portalId" : 62515,
"appKey" : "twitter",
"createdAt" : 1327698967809,
"updatedAt" : 0
},
{
"name" : "companyName",
"value" : "google",
"portalId" : 62515,
"appKey" : null,
"createdAt" : 1327698968519,
"updatedAt" : 0
},
{
"name" : "externalDomain",
"value" : "demo.hubapi.com",
"portalId" : 62515,
"appKey" : null,
"createdAt" : 1327698969324,
"updatedAt" : 0
},
{
"name" : "primaryPortalAlias",
"value" : "demo.hubapi.com",
"portalId" : 62515,
"appKey" : null,
"createdAt" : 1327698969324,
"updatedAt" : 0
},
{
"name" : "cmsPrimaryDomain",
"value" : "demo.hubapi.com",
"portalId" : 62515,
"appKey" : null,
"createdAt" : 1327698969324,
"updatedAt" : 0
},
{
"name" : "primaryAppDomain",
"value" : "demohubapi.app6.hubspot.com",
"portalId" : 62515,
"appKey" : null,
"createdAt" : 1327698969324,
"updatedAt" : 0
}
]
}
]
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers