HubSpot · Schema

RefreshTokenMetadata

Metadata associated with an OAuth refresh token

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
token string The refresh token string
client_id string The client ID of the application
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
scopes array List of scopes granted to this token
View JSON Schema on GitHub

JSON Schema

hubspot-oauth-refresh-token-metadata-schema.json Raw ↑ 
{
  "type": "object",
  "description": "Metadata associated with an OAuth refresh token",
  "properties": {
    "token": {
      "type": "string",
      "description": "The refresh token string",
      "example": "6f18f26a-3e95-4d95-a6e5-3d5c6e5c9e5a"
    },
    "client_id": {
      "type": "string",
      "description": "The client ID of the application",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "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]"
    },
    "scopes": {
      "type": "array",
      "description": "List of scopes granted to this token",
      "example": [
        "contacts",
        "content"
      ],
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "token",
    "client_id",
    "hub_id",
    "scopes"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RefreshTokenMetadata"
}