GET
/
communication-preferences
/
v3
/
definitions
Get subscription definitions
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v3/definitions \
  --header 'Authorization: Bearer <token>'
{
  "subscriptionDefinitions": [
    {
      "isInternal": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "isDefault": true,
      "communicationMethod": "<string>",
      "purpose": "<string>",
      "name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "isActive": true,
      "businessUnitId": 123,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

​
Required Scopes

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.

Response

200
application/json

successful operation

The response is of type object.