HubSpot: Retrieve all subscription status definitions

← Communication preferences operations · Get started

Operation hubspot.communication_preferences_get_subscription_definitions

Provider route: GET /communication-preferences/2026-09/definitions. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["communicationPreferences"]["getSubscriptionDefinitions"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.communicationPreferences.getSubscriptionDefinitions(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.communication_preferences.get_subscription_definitions(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.businessUnitId	integer	Optional	Format: int64
query.includeTranslations	boolean	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Retrieve all subscription status definitions — response body

Referenced models: Retrieve all subscription status definitions — response body

Schemas

Retrieve all subscription status definitions — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the operation was completed. Format: date-time
errors	array	Optional	An array of errors that occurred during the operation.
errors[]	Model	Each item	Expand Batch update subscription status — response body — errors item
links	object	Optional	A collection of related links associated with the operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the operation was requested. Format: date-time
results	array	Required within parent	An array containing the results of the operation.
results[]	Model	Each item	Expand Retrieve all subscription status definitions — response body — results item
startedAt	string	Required within parent	The date and time when the operation started. Format: date-time
status	string	Required within parent	The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch update subscription status — response body — errors item, Retrieve all subscription status definitions — response body — results item

Batch update subscription status — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string that categorizes the type of error.
context	object	Required within parent	An object containing additional context about the error condition, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier of the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Retrieve all subscription status definitions — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
businessUnitId	JSON	Optional
businessUnitId (anyOf 1)	integer	Alternative	The ID of the business unit associated with the subscription. Format: int64
businessUnitId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
communicationMethod	string	Optional	The method of communication for the subscription.
createdAt	string	Required within parent	The date and time when the subscription was created. Format: date-time
description	string	Required within parent	A description of the subscription.
id	string	Required within parent	The unique identifier for the subscription.
isActive	boolean	Required within parent	Indicates whether the subscription is active.
isDefault	boolean	Required within parent	Indicates whether the subscription is the default option.
isInternal	boolean	Required within parent	Indicates whether the subscription is internal.
name	string	Required within parent	The name of the subscription.
purpose	string	Optional	The purpose of the subscription.
subscriptionTranslations	array	Optional	A list of translations associated with the subscription.
subscriptionTranslations[]	Model	Each item	Expand Retrieve all subscription status definitions — response body — results item subscription Translations item
updatedAt	string	Required within parent	The date and time when the subscription was last updated. Format: date-time

Referenced models: Retrieve all subscription status definitions — response body — results item subscription Translations item

Batch insert events — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail
context	object	Optional	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	string	Optional	A specific category that contains more specific detail about the error

Retrieve all subscription status definitions — response body — results item subscription Translations item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	The timestamp indicating when the subscription translation was created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Required within parent	A text description of the subscription translation.
languageCode	string	Required within parent	The code representing the language of the subscription translation.
name	string	Required within parent	The name of the subscription translation.
subscriptionId	JSON	Required within parent
subscriptionId (anyOf 1)	integer	Alternative	The unique identifier for the subscription associated with the translation. Format: int64
subscriptionId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	The timestamp indicating when the subscription translation was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.communication_preferences_get_subscription_definitions. Catalog operation: communication_preferences_get_subscription_definitions. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["communication_preferences.read", "communication_preferences.read_write"]

Official provider source