Creating legacy public apps and project-based apps is temporarily unavailable for new HubSpot accounts.
Learn more in our Trust Center.
curl --request GET \
--url https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress} \
--header 'Authorization: Bearer <token>'{
"recipient": "<string>",
"subscriptionStatuses": [
{
"description": "<string>",
"id": "<string>",
"name": "<string>",
"sourceOfStatus": "BRAND_WIDE_STATUS",
"status": "NOT_SUBSCRIBED",
"brandId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>",
"preferenceGroupName": "<string>"
}
]
}Returns a list of subscriptions and their status for a given contact.
curl --request GET \
--url https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress} \
--header 'Authorization: Bearer <token>'{
"recipient": "<string>",
"subscriptionStatuses": [
{
"description": "<string>",
"id": "<string>",
"name": "<string>",
"sourceOfStatus": "BRAND_WIDE_STATUS",
"status": "NOT_SUBSCRIBED",
"brandId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>",
"preferenceGroupName": "<string>"
}
]
}Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
Was this page helpful?