HubSpot · Schema

TokenResponse

Response containing the new access token and related information

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
access_token string The new access token
token_type string The type of token (always 'bearer')
expires_in integer Number of seconds until the access token expires
refresh_token string The refresh token for obtaining new access tokens
id_token string The ID token (only returned if openid scope was requested)
View JSON Schema on GitHub

JSON Schema

oauth-api-token-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/oauth-api-token-response-schema.json",
  "title": "TokenResponse",
  "description": "Response containing the new access token and related information",
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "The new access token",
      "example": "CKDZpunPLhICAQEYs-gDIIGOBii1hQIyGQAf3xBKEgsYjYMJVvlHEz9tFHAwSq1TQAM40s0D"
    },
    "token_type": {
      "type": "string",
      "description": "The type of token (always 'bearer')",
      "example": "bearer"
    },
    "expires_in": {
      "type": "integer",
      "description": "Number of seconds until the access token expires",
      "example": 1800
    },
    "refresh_token": {
      "type": "string",
      "description": "The refresh token for obtaining new access tokens",
      "example": "6f18f26a-3e95-4d95-a6e5-3d5c6e5c9e5a"
    },
    "id_token": {
      "type": "string",
      "description": "The ID token (only returned if openid scope was requested)",
      "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  },
  "required": [
    "access_token",
    "token_type",
    "expires_in",
    "refresh_token"
  ]
}