---
title: "Retrieve all subscription status definitions"
method: GET
path: "/communication-preferences/2026-03/definitions"
tags: ["Definitions"]
---

# Retrieve all subscription status definitions

`GET /communication-preferences/2026-03/definitions`

## Request

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

Get a list of subscription status definitions from the account.

## Query parameters

- `businessUnitId` integer
- `includeTranslations` boolean

## Response `200`

successful operation

- CommunicationPreferencesActionResponseWithResultsSubscriptionDefinition
  - `completedAt` string, date-time, required: The date and time when the operation was completed.
  - `errors` StandardError[]: An array of errors that occurred during the operation.
    - `category` string, required: Error category.
    - `context` object, required: Error context.
    - `errors` ErrorDetail[], required: List of error details.
      - `code` string: The status code associated with the error detail
      - `context` object: Context about the error condition
      - `in` string: The name of the field or parameter in which the error was found.
      - `message` string, required: A human readable message describing the error along with remediation steps where appropriate
      - `subCategory` string: A specific category that contains more specific detail about the error
    - `id` string: Error ID.
    - `links` object, required: Error links.
    - `message` string, required: Error message.
    - `status` string, required: Error status.
    - `subCategory` object: Error subcategory.
  - `links` object: A collection of related links associated with the operation.
  - `numErrors` integer: The number of errors encountered during the operation.
  - `requestedAt` string, date-time: The date and time when the operation was requested.
  - `results` CommunicationPreferencesSubscriptionDefinition[], required: An array containing the results of the operation.
    - `businessUnitId` integer: The ID of the business unit associated with the subscription.
    - `communicationMethod` string: The method of communication for the subscription.
    - `createdAt` string, date-time, required: The date and time when the subscription was created.
    - `description` string, required: A description of the subscription.
    - `id` string, required: The unique identifier for the subscription.
    - `isActive` boolean, required: Indicates whether the subscription is active.
    - `isDefault` boolean, required: Indicates whether the subscription is the default option.
    - `isInternal` boolean, required: Indicates whether the subscription is internal.
    - `name` string, required: The name of the subscription.
    - `purpose` string: The purpose of the subscription.
    - `subscriptionTranslations` CommunicationPreferencesPublicSubscriptionTranslation[]: A list of translations associated with the subscription.
      - `createdAt` integer, required: The timestamp indicating when the subscription translation was created.
      - `description` string, required: A text description of the subscription translation.
      - `languageCode` string, required: The code representing the language of the subscription translation.
      - `name` string, required: The name of the subscription translation.
      - `subscriptionId` integer, required: The unique identifier for the subscription associated with the translation.
      - `updatedAt` integer, required: The timestamp indicating when the subscription translation was last updated.
    - `updatedAt` string, date-time, required: The date and time when the subscription was last updated.
  - `startedAt` string, 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.

## Other responses

- `default`: An error occurred.

## Changes

> 14 revisions in range; 1 not diffed, 2 could not be searched.

- **2026-04-08** `b0d8bc008db9`: 2 info
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- **2026-04-03** `3578967e48df`: 2 info
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- **2026-04-01** `e0403341222c`: 2 info
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- **2026-03-31** `f33be5a82610`: 2 info
  - the security scope `communication_preferences.read` was added to the endpoint's security scheme `private_apps`
  - the security scope `communication_preferences.read_write` was removed from the endpoint's security scheme `private_apps`
- …earlier changes not shown

[Operation history](https://skmtc.dev/hubspot/apis/hubspot-api-specification/changes/communication-preferences/2026-03/definitions/get.md)

---

[API](https://skmtc.dev/hubspot/apis/hubspot-api-specification.md) - [All operations](https://skmtc.dev/hubspot/apis/hubspot-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/hubspot-api-specification/revisions/f9c7181056c5?raw)