HubSpot · Schema

AccessTokenMetadata

Metadata associated with an OAuth access token

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
token string The access token string
app_id integer The ID of the HubSpot application associated with this token
hub_id integer The HubSpot portal (hub) ID associated with this token
user_id integer The ID of the user who authorized the token
user string The email address of the user who authorized the token
hub_domain string The domain of the HubSpot portal
scopes array List of scopes granted to this token
token_type string The type of token (always 'access')
expires_in integer Number of seconds until the token expires
View JSON Schema on GitHub

JSON Schema

hubspot-oauth-access-token-metadata-schema.json Raw ↑
{
  "type": "object",
  "description": "Metadata associated with an OAuth access token",
  "properties": {
    "token": {
      "type": "string",
      "description": "The access token string",
      "example": "CKDZpunPLhICAQEYs-gDIIGOBii1hQIyGQAf3xBKEgsYjYMJVvlHEz9tFHAwSq1TQAM40s0D"
    },
    "app_id": {
      "type": "integer",
      "description": "The ID of the HubSpot application associated with this token",
      "example": 456789
    },
    "hub_id": {
      "type": "integer",
      "description": "The HubSpot portal (hub) ID associated with this token",
      "example": 62515
    },
    "user_id": {
      "type": "integer",
      "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": "[email protected]"
    },
    "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",
      "example": [
        "contacts",
        "content"
      ],
      "items": {
        "type": "string"
      }
    },
    "token_type": {
      "type": "string",
      "description": "The type of token (always 'access')",
      "example": "access"
    },
    "expires_in": {
      "type": "integer",
      "description": "Number of seconds until the token expires",
      "example": 1800
    }
  },
  "required": [
    "token",
    "app_id",
    "hub_id",
    "scopes",
    "token_type",
    "expires_in"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AccessTokenMetadata"
}