GET
/
communication-preferences
/
v4
/
definitions
Retrieve all subscription status definitions
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/definitions \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "isInternal": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "isDefault": true,
      "communicationMethod": "<string>",
      "purpose": "<string>",
      "name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "isActive": true,
      "businessUnitId": 123,
      "subscriptionTranslations": [
        {
          "createdAt": 123,
          "name": "<string>",
          "description": "<string>",
          "subscriptionId": 123,
          "languageCode": "<string>",
          "updatedAt": 123
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "subCategory": "",
      "context": "",
      "links": "",
      "id": "",
      "category": "",
      "message": "",
      "errors": "",
      "status": ""
    }
  ],
  "status": "PENDING"
}
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.

Query Parameters

​
businessUnitId
integer

If you have the business unit add-on, include this parameter to filter results by business unit ID. The default Account business unit will always use 0.

​
includeTranslations
boolean

Set to true to return subscription translations associated with each definition.

Response

200
application/json

successful operation

The response is of type object.