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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.after | string | Optional | |
query.campaignName | string | Optional | |
query.emailCampaignId | string | Optional | |
query.limit | integer | Optional | Format: int32 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”Query SMTP API tokens by campaign name or an email Campaign Id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging |
results | array | Required within parent | An array of SMTP API token objects, each representing a token with its associated details. |
results[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
campaignName | string | Required within parent | A name for the campaign tied to the token. |
createContact | boolean | Required within parent | Indicates whether a contact should be created for email recipients. |
createdAt | string | Required within parent | Timestamp generated when a token is created. Format: date-time |
createdBy | string | Required within parent | Email address of the user that sent the token creation request. |
emailCampaignId | string | Required within parent | Identifier assigned to the campaign provided in the token creation request. |
id | string | Required within parent | User name to log into the HubSpot SMTP server. |
password | string | Optional | Password used to log into the HubSpot SMTP server. |
Query SMTP API tokens by campaign name or an email Campaign Id — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. |
next | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the paging information needed to retrieve the next set of results in a paginated API response |
after | string | Required within parent | A string token used to retrieve the next page of results. It indicates the position after the last item on the current page. |
link | string | Optional | A string containing the URL link to the next page of results. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]