There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get email subscription status for an email address

Last updated January 7, 2025

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

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

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 private app access token Authorization: Bearer {token} header 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:  http://api.hubapi.com/email/public/v1/subscriptions/jerry@example.org

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: http://api.hubapi.com/email/public/v1/subscriptions/jerry@example.org { "subscribed": false, "markedAsSpam": false, "portalId": 62515, "bounced": false, "email": "jerry@example.org", "subscriptionStatuses": [], "status": "unsubscribed" }