HubSpot: Account info schemas

← Account info operations · All schemas

Retrieve API Usage — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of API usage records, each detailing the usage metrics for a specific API. Each record includes information such as the name of the API, usage limits, current usage, and the status of the data fetch.
results[]	Model	Each item	Expand Retrieve API Usage — response body — results item

Referenced models: Retrieve API Usage — response body — results item

Retrieve API Usage — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
collectedAt	string	Required within parent	The date and time when the usage data was collected, in ISO 8601 format. Format: date-time
currentUsage	JSON	Required within parent
currentUsage (anyOf 1)	integer	Alternative	An integer indicating the current usage count of the API resource. Format: int32
currentUsage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fetchStatus	string	Required within parent	The status of the data fetch operation. Valid values include 'SUCCESS', 'TIMEOUT', 'FAILURE', 'CACHED', and 'NOTFOUND'. Known values: CACHED, FAILURE, NOTFOUND, SUCCESS, TIMEOUT
name	string	Required within parent	The name of the API resource being tracked.
resetsAt	string	Optional	The date and time when the usage limit will reset, in ISO 8601 format. Format: date-time
usageLimit	JSON	Required within parent
usageLimit (anyOf 1)	integer	Alternative	An integer representing the maximum allowable usage for the API resource. Format: int32
usageLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve details — response body

Field	Type	Presence	Description and constraints
$	object	Root
accountType	string	Required within parent	The type of account associated with the portal. Valid values include 'STANDARD', 'DEVELOPER_TEST', 'SANDBOX', and 'APP_DEVELOPER'. Known values: APP_DEVELOPER, DEVELOPER_TEST, SANDBOX, STANDARD
additionalCurrencies	array	Required within parent	An array of additional currencies supported by the portal, each represented as a string.
additionalCurrencies[]	string	Each item
companyCurrency	string	Required within parent	The primary currency used by the company, represented as a string.
createdAt	JSON	Optional
createdAt (anyOf 1)	integer	Alternative	The timestamp when the portal was created, represented as a Unix timestamp in milliseconds. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dataHostingLocation	string	Required within parent	The location where the portal's data is hosted, represented as a string.
portalId	JSON	Required within parent
portalId (anyOf 1)	integer	Alternative	The unique identifier for the HubSpot portal, represented as an integer. Format: int32
portalId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
portalName	string	Optional	The name of the portal, represented as a string.
timeZone	string	Required within parent	The time zone setting of the portal, represented as a string.
uiDomain	string	Required within parent	The domain used for the portal's user interface, represented as a string.
utcOffset	string	Required within parent	The UTC offset of the portal's time zone, represented as a string.
utcOffsetMilliseconds	JSON	Required within parent
utcOffsetMilliseconds (anyOf 1)	integer	Alternative	The UTC offset of the portal's time zone in milliseconds, represented as an integer. Format: int64
utcOffsetMilliseconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$