List SMTP API Tokens

There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Method Details

HTTP Methods:

GET

Response Format:

JSON

Requires Authentication?

Yes

Rate Limited?

Required Scope

transactional-email

List SMTP API tokens which can then be used to send email through HubSpot's SMTP API. Tokens listed here were created using the Create SMTP API Tokens endpoint.
Note that this API will not return passwords. Passwords are only returned during token creation, and during password reset (at which point a new password is generated).

Note that use of API requires the Transactional Email add-on.

Required Parameters	How to use	Description
OAuth Access Token	Authorization: Bearer {token} Used in the request headers	Used to authenticate the request. Please see this page for more details about authentication. NOTE: You must use an OAuth access token to create an event. API keys are not supported.

Example

Example URL: https://api.hubapi.com/email/public/v1/smtpapi/tokens

Example JSON Response

[
    {
      "portalId": 62515,
      "userName": "hrfdvt58el@62515.smtp.hubspot.net",
      "emailCampaignId": 14845842,
      "createdAt": 1415660606232,
      "deleted": false,
      "createdBy": "maxiak@hubspot.com",
      "appId": 22709,
      "campaignName": "TransactionalTest"
    },
    {
      "portalId": 62515,
      "userName": "jjtww8xdue@62515.smtp.hubspot.net",
      "emailCampaignId": 14845848,
      "createdAt": 1415660619230,
      "deleted": false,
      "createdBy": "maxiak@hubspot.com",
      "appId": 22709,
      "campaignName": "TransactionalTest12"
    }
]

The emailCampaignId and appId fields above can be used in the Email Events API.

[ { "portalId": 62515, "userName": "hrfdvt58el@62515.smtp.hubspot.net", "emailCampaignId": 14845842, "createdAt": 1415660606232, "deleted": false, "createdBy": "maxiak@hubspot.com", "appId": 22709, "campaignName": "TransactionalTest" }, { "portalId": 62515, "userName": "jjtww8xdue@62515.smtp.hubspot.net", "emailCampaignId": 14845848, "createdAt": 1415660619230, "deleted": false, "createdBy": "maxiak@hubspot.com", "appId": 22709, "campaignName": "TransactionalTest12" } ]

import requests import urllib # Get all SMTP tokens def get_smtp_api_tokens(**params): if not (params.get('access_token')): raise Exception("Expecting access_token") r = requests.get("https://api.hubapi.com/email/public/v1/smtpapi/tokens?" + urllib.urlencode(params)) if 200 <= r.status_code < 300: return r.json() else: raise Exception("Unknown error with HubSpot API: code:{0}, response:{1}".format(r.status_code, r.content)) for token in get_smtp_api_tokens(access_token='demo'): print "Username: " + token['userName'] print "Campaign name: " + token['campaignName']

#!/usr/bin/env ruby require 'net/http' require 'cgi' require 'json' # Get all tokens for a given access_token def get_smtp_api_tokens(access_token) url = URI.parse("https://api.hubapi.com/email/public/v1/smtpapi/tokens?access_token=#{CGI.escape(access_token)}") res = Net::HTTP.get_response(url) if res.code == '200' JSON.parse res.body else raise RuntimeError("Invalid response from HubSpot API. Code: #{res.code}. Response: #{res.body}") end end response = get_smtp_api_tokens('demo') response.each do |token| puts "Username: #{token['userName']}" puts "CampaignName: #{token['campaignName']}" end

<?php /** Get SMTP API Tokens as simple associative arrays in PHP */ function get_smtp_api_tokens($accesstoken) { $url = "https://api.hubapi.com/email/public/v1/smtpapi/tokens=" . urlencode($accesstoken); $ch = @curl_init(); @curl_setopt($ch, CURLOPT_URL, $url); @curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = @curl_exec($ch); // Log the response from HubSpot as needed. $status_code = @curl_getinfo($ch, CURLINFO_HTTP_CODE); // Log the response status code @curl_close($ch); if ($status_code <= 200 && $status_code < 300) { return json_decode($response, true); } else { throw new Exception("Unhandled exception in HubSpot API: code: $status_code, response: $response"); } } // Use the authentication access token for the user here. $accesstoken = 'demo'; foreach (get_smtp_api_tokens($accesstoken) as $smtpapiToken) { echo "Username: " . $smtpapiToken['userName'] . "\n"; echo "CampaignName: " . $smtpapiToken['campaignName'] . "\n"; } ?>

$ curl https://api.hubapi.com/email/public/v1/smtpapi/tokens [ { "portalId": 62515, "userName": "hrfdvt58el@62515.smtp.hubspot.net", "emailCampaignId": 14845842, "createdAt": 1415660606232, "deleted": false, "createdBy": "maxiak@hubspot.com", "appId": 22709, "campaignName": "TransactionalTest" }, { "portalId": 62515, "userName": "jjtww8xdue@62515.smtp.hubspot.net", "emailCampaignId": 14845848, "createdAt": 1415660619230, "deleted": false, "createdBy": "maxiak@hubspot.com", "appId": 22709, "campaignName": "TransactionalTest12" } ]