HUhubspot
Definitions

Retrieve all subscription status definitions

Changed on

Get a list of subscription status definitions from the account.

get/communication-preferences/2026-03/definitions

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-03/definitions
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Query parameters

businessUnitIdinteger

An integer representing the ID of the business unit for which to retrieve subscription definitions.

includeTranslationsboolean

A boolean indicating whether to include translations of the communication preferences definitions in the response.

Response

successful operation

completedAtstring date-time required

The date and time when the operation was completed.

linksobject

A collection of related links associated with the operation.

numErrorsinteger

The number of errors encountered during the operation.

requestedAtstring date-time

The date and time when the operation was requested.

startedAtstring date-time required

The date and time when the operation started.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.

Changes

  • b0d8bc008db9Revision changes
    • info

      the security scope communication_preferences.read was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.read_write was removed from the endpoint's security scheme private_apps

  • 3578967e48dfRevision changes
    • info

      the security scope communication_preferences.read was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.read_write was removed from the endpoint's security scheme private_apps

Some revisions have not been checked yet.