HubSpot · JSON Structure

Hubspot Oauth Access Token Metadata Structure

Metadata associated with an OAuth access token

Type: object Properties: 9 Required: 6
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

AccessTokenMetadata is a JSON Structure definition published by HubSpot, describing 9 properties, of which 6 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

token app_id hub_id user_id user hub_domain scopes token_type expires_in

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "Metadata associated with an OAuth access token",
  "name": "AccessTokenMetadata",
  "properties": {
    "token": {
      "type": "string",
      "description": "The access token string"
    },
    "app_id": {
      "type": "integer",
      "description": "The ID of the HubSpot application associated with this token"
    },
    "hub_id": {
      "type": "integer",
      "description": "The HubSpot portal (hub) ID associated with this token"
    },
    "user_id": {
      "type": "integer",
      "description": "The ID of the user who authorized the token"
    },
    "user": {
      "type": "string",
      "description": "The email address of the user who authorized the token"
    },
    "hub_domain": {
      "type": "string",
      "description": "The domain of the HubSpot portal"
    },
    "scopes": {
      "type": "array",
      "description": "List of scopes granted to this token",
      "items": {
        "type": "string"
      }
    },
    "token_type": {
      "type": "string",
      "description": "The type of token (always 'access')"
    },
    "expires_in": {
      "type": "integer",
      "description": "Number of seconds until the token expires"
    }
  },
  "required": [
    "token",
    "app_id",
    "hub_id",
    "scopes",
    "token_type",
    "expires_in"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}