Skip to main content
GET
/
communication-preferences
/
v3
/
status
/
email
/
{emailAddress}
Get subscription statuses for a contact
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress} \
  --header 'Authorization: Bearer <token>'
{
  "recipient": "<string>",
  "subscriptionStatuses": [
    {
      "brandId": 123,
      "name": "<string>",
      "description": "<string>",
      "legalBasis": "LEGITIMATE_INTEREST_PQL",
      "preferenceGroupName": "<string>",
      "id": "<string>",
      "legalBasisExplanation": "<string>",
      "status": "SUBSCRIBED",
      "sourceOfStatus": "PORTAL_WIDE_STATUS"
    }
  ]
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
This API requires one of the following scopes:
communication_preferences.read
communication_preferences.read_write

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

emailAddress
string
required

Response

successful operation

recipient
string
required

Email address of the contact.

subscriptionStatuses
object[]
required

A list of all of the contact's subscriptions statuses.