Retrieve OAuth token metadata

curl --request GET \
  --url https://api.hubapi.com/oauth/v1/access-tokens/{token}

{
  "app_id": 123,
  "expires_in": 123,
  "hub_id": 123,
  "scopes": [
    "<string>"
  ],
  "token": "<string>",
  "token_type": "<string>",
  "user_id": 123,
  "hub_domain": "<string>",
  "is_private_distribution": true,
  "signed_access_token": {
    "appId": 123,
    "expiresAt": 123,
    "hubId": 123,
    "hublet": "<string>",
    "installingUserId": 123,
    "isPrivateDistribution": true,
    "isServiceAccount": true,
    "isUserLevel": true,
    "newSignature": "<string>",
    "scopeToScopeGroupPks": "<string>",
    "scopes": "<string>",
    "signature": "<string>",
    "trialScopeToScopeGroupPks": "<string>",
    "trialScopes": "<string>",
    "userId": 123
  },
  "user": "<string>"
}

GET

oauth

access-tokens

{token}

Retrieve OAuth token metadata

curl --request GET \
  --url https://api.hubapi.com/oauth/v1/access-tokens/{token}

{
  "app_id": 123,
  "expires_in": 123,
  "hub_id": 123,
  "scopes": [
    "<string>"
  ],
  "token": "<string>",
  "token_type": "<string>",
  "user_id": 123,
  "hub_domain": "<string>",
  "is_private_distribution": true,
  "signed_access_token": {
    "appId": 123,
    "expiresAt": 123,
    "hubId": 123,
    "hublet": "<string>",
    "installingUserId": 123,
    "isPrivateDistribution": true,
    "isServiceAccount": true,
    "isUserLevel": true,
    "newSignature": "<string>",
    "scopeToScopeGroupPks": "<string>",
    "scopes": "<string>",
    "signature": "<string>",
    "trialScopeToScopeGroupPks": "<string>",
    "trialScopes": "<string>",
    "userId": 123
  },
  "user": "<string>"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing HubGrátis

Sales HubGrátis

Service HubGrátis

Content HubGrátis

Path Parameters

token

string

required

The access token that you want to retrieve information about.

Response

successful operation

app_id

integer<int32>

required

The ID of the application associated with the access token.

expires_in

integer<int32>

required

The time in seconds until the access token expires.

hub_id

integer<int32>

required

The ID of the HubSpot account associated with the access token.

scopes

string[]

required

token

string

required

The access token string used to make API calls.

token_type

string

required

The type of token, typically indicating the authentication scheme. Typically bearer.

user_id

integer<int32>

required

The ID of the hubspot user for whom the access token was created.

hub_domain

string

The domain of the HubSpot account associated with the access token.

is_private_distribution

boolean

Indicates whether the token is for a privately distributed application. If false, it is marketplace distributed.

signed_access_token

object

Mostrar atributos filhos

signed_access_token.appId

integer<int32>

required

The ID of the application associated with the access token.

signed_access_token.expiresAt

integer<int64>

required

The timestamp indicating when the access token will expire.

signed_access_token.hubId

integer<int32>

required

The ID of the HubSpot account associated with the access token.

signed_access_token.hublet

string

required

The specific regional data center where the account is hosted.

signed_access_token.installingUserId

integer<int32>

required

The ID of the user who installed the application.

signed_access_token.isPrivateDistribution

boolean

required

Indicates whether the token is for a privately distributed application. If false, it is marketplace distributed.

signed_access_token.isServiceAccount

boolean

required

Indicates whether the access token is associated with a service account. Meaning it is decoupled from the user who installed it.

signed_access_token.isUserLevel

boolean

required

Indicates whether the access token is issued at the user level. Meaning the app is configured to allow multiple installs of the same app on a hub.

signed_access_token.newSignature

string

required

The updated cryptographic signature for the access token.

signed_access_token.scopeToScopeGroupPks

string

required

A mapping of scopes to their corresponding scope group primary keys.

signed_access_token.scopes

string

required

The permissions granted to the access token.

signed_access_token.signature

string

required

The cryptographic signature used to verify the integrity of the access token.

signed_access_token.trialScopeToScopeGroupPks

string

required

A mapping of trial scopes to their corresponding scope group primary keys.

signed_access_token.trialScopes

string

required

The trial scopes included in the access token.

signed_access_token.userId

integer<int32>

required

The ID of the hubspot user associated with the access token.

user

string

The email address of the hubspot user for whom the access token was created.

Last modified on August 31, 2025

Refresh an access token

Retrieve refresh token metadata

⌘I