HUhubspot
Definitions

Retrieve all subscription status definitions

Changed on

Get a list of subscription status definitions from the account.

get/communication-preferences/2026-09/definitions

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-09/definitions
  • Auth
    OAuth 2
    Authorization code: https://app.hubspot.com/oauth/authorize
    Token URL: https://api.hubapi.com/oauth/v1/token scopes: communication_preferences.read_write

Query parameters

businessUnitIdinteger

An integer representing the unique identifier of the business unit for which to retrieve communication preferences definitions.

includeTranslationsboolean

A boolean indicating whether to include translations for the subscription definitions. Defaults to false if not specified.

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

  • 2026-09e1706f57adc0Revision changes
    • breaking

      the //// response's property format changed from int32 to int64 for status

    • breaking

      the //// response's property format changed from int32 to int64 for status

    • breaking

      the //// response's property format changed from int32 to int64 for status

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the security scope communication_preferences.read_write was added to the endpoint's security scheme oauth2

    • info

      the security scope communication_preferences.read was removed from the endpoint's security scheme oauth2

    • info

      api tag Definitions added

    • info

      api tag Basic removed