There's a new version of the HubSpot API

Check out the new API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get email subscription types for a Hub ID

Last updated May 15, 2023

GET /email/public/v1/subscriptions

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

Returns all email subscription types that have been created in the given Hub ID.

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.
HubSpot Portal ID portalId=X - Used in the request URL The HubSpot Portal ID for the portal that you're making the call for.
Optional Parameters How to use Description

Example URL:  http://api.hubapi.com/email/public/v1/subscriptions

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: https://api.hubapi.com/email/public/v1/subscriptions Example response: { "subscriptionDefinitions": [ { "active": true, "portalId": 12345, "description": "The default unsubscribe list that all emails in your hub will use", "id": 7, "name": "Default" }, { "active": true, "portalId": 12345, "description": "Our weekly newsletter informing you about our new happenings", "id": 146, "name": "Weekly Newsletter" }] }