Scope requirements
Scope requirements
Get account details for a HubSpot account
To retrieve details for a standard HubSpot account, make aGET request to /account-info/v3/details. The response will resemble the following:
| Property | Type | Description |
|---|---|---|
portalId | Number | The ID of the HubSpot account, sometimes referred to as the account’s Hub ID. |
accountType | String | An enumeration corresponding to the account type:
|
timeZone | String | The name of the account’s configured timezone (e.g., "US/Eastern"). |
companyCurrency | String | The currency code of the account’s configured currency. |
additionalCurrencies | Array | An array of additional configured currencies. Note that a Starter account or higher is required to add more than one account currency. |
utcOffset | String | The difference in hours between the account’s timezone and Coordinated Universal Time (UTC). |
| `utcOffsetMilliseconds | Number | The difference in milliseconds between the account’s timezone and Coordinated Universal Time (UTC). |
uiDomain | String | The domain used to log in to the main HubSpot user interface. |
dataHostingLocation | String | The location of the data center where your account is hosted (e.g., "eu1" or "na1"). |
Check daily API usage and limits for a legacy private app
The daily API usage endpoint can be used to check the aggregate API calls that all legacy private apps have made for the current day, and the API usage limits for that account. The current day is measured from midnight to midnight based on the connected account’s time zone settings. Read more about HubSpot’s API usage guidelines. To retrieve usage and limit data for your legacy private apps, make aGET request to /account-info/v3/api-usage/daily/private-apps.
The response will resemble the following:
results array of the response:
| Property | Type | Description |
|---|---|---|
name | String | An identifier used by HubSpot for the API call. |
usageLimit | Number | The daily limit for your legacy private apps. |
currentUsage | Number | The total number of calls your legacy private apps have made during the current period (starting from midnight of the current day). |
collectedAt | String | An ISO 8601 timestamp denoting when usage was measured. |
fetchStatus | String | An enumeration denoting the status of the usage request. |
resetsAt | String | An ISO 8601 timestamp denoting when the current period of usage will reset. |