HubSpot · JSON Structure

Oauth Api 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/meta/core/v0/# meta-schema.

Properties

token app_id hub_id user_id user hub_domain scopes token_type expires_in

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/oauth-api-access-token-metadata-structure.json",
  "name": "AccessTokenMetadata",
  "description": "Metadata associated with an OAuth access token",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "The access token string",
      "example": "CKDZpunPLhICAQEYs-gDIIGOBii1hQIyGQAf3xBKEgsYjYMJVvlHEz9tFHAwSq1TQAM40s0D"
    },
    "app_id": {
      "type": "int32",
      "description": "The ID of the HubSpot application associated with this token",
      "example": 456789
    },
    "hub_id": {
      "type": "int32",
      "description": "The HubSpot portal (hub) ID associated with this token",
      "example": 62515
    },
    "user_id": {
      "type": "int32",
      "description": "The ID of the user who authorized the token",
      "example": 123456
    },
    "user": {
      "type": "string",
      "description": "The email address of the user who authorized the token",
      "example": "user@example.com"
    },
    "hub_domain": {
      "type": "string",
      "description": "The domain of the HubSpot portal",
      "example": "demo.hubspot.com"
    },
    "scopes": {
      "type": "array",
      "description": "List of scopes granted to this token",
      "items": {
        "type": "string"
      },
      "example": [
        "contacts",
        "content"
      ]
    },
    "token_type": {
      "type": "string",
      "description": "The type of token (always 'access')",
      "example": "access"
    },
    "expires_in": {
      "type": "int32",
      "description": "Number of seconds until the token expires",
      "example": 1800
    }
  },
  "required": [
    "token",
    "app_id",
    "hub_id",
    "scopes",
    "token_type",
    "expires_in"
  ]
}