There's a new version of the HubSpot 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.

Get email subscription status for an email address

Last updated September 15, 2020

GET /email/public/v1/subscriptions/:email_address

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:


For a given portal, return the email subscription information for the given email address and portal. For specific email subscription types, if the value is true or false, the definition will be returned. If the value is null for a specific type, nothing will be returned.

A null value in this circumstance signifies a contact whose subscription preferences have never been changed, and therefore are not opted out of that type.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Email Address :email_address - Used in the request URL The email address for which you are requesting subscription status.
Optional Parameters How to use Description

Example URL: