Skip to content

HubSpot: Query SMTP API tokens by campaign name or an email Campaign Id

HubSpot transactionalEmail.listSmtpTokens: arguments, response, policy and SDK examples.

← Transactional email operations · Get started

Operation hubspot.transactional_email_list_smtp_tokens

Provider route: GET /marketing/transactional/2026-09/smtp-tokens. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["transactionalEmail"]["listSmtpTokens"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.transactionalEmail.listSmtpTokens(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.transactional_email.list_smtp_tokens(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.afterstringOptional
query.campaignNamestringOptional
query.emailCampaignIdstringOptional
query.limitintegerOptionalFormat: int32

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Query SMTP API tokens by campaign name or an email Campaign Id — response body

Referenced models: Query SMTP API tokens by campaign name or an email Campaign Id — response body

Query SMTP API tokens by campaign name or an email Campaign Id — response body
FieldTypePresenceDescription and constraints
$objectRoot
pagingModelOptionalExpand Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging
resultsarrayRequired within parentAn array of SMTP API token objects, each representing a token with its associated details.
results[]ModelEach itemExpand Create a SMTP API token — response body

Referenced models: Create a SMTP API token — response body, Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging

Create a SMTP API token — response body
FieldTypePresenceDescription and constraints
$objectRoot
campaignNamestringRequired within parentA name for the campaign tied to the token.
createContactbooleanRequired within parentIndicates whether a contact should be created for email recipients.
createdAtstringRequired within parentTimestamp generated when a token is created.
Format: date-time
createdBystringRequired within parentEmail address of the user that sent the token creation request.
emailCampaignIdstringRequired within parentIdentifier assigned to the campaign provided in the token creation request.
idstringRequired within parentUser name to log into the HubSpot SMTP server.
passwordstringOptionalPassword used to log into the HubSpot SMTP server.
Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging
FieldTypePresenceDescription and constraints
$objectRootPaging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
nextModelOptionalExpand Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging next

Referenced models: Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging next

Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging next
FieldTypePresenceDescription and constraints
$objectRootSpecifies the paging information needed to retrieve the next set of results in a paginated API response
afterstringRequired within parentA string token used to retrieve the next page of results. It indicates the position after the last item on the current page.
linkstringOptionalA string containing the URL link to the next page of results.

SDK function policy ID: hubspot.transactional_email_list_smtp_tokens. Catalog operation: transactional_email_list_smtp_tokens. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["transactional-email"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.