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

# Retrieve all subscription status definitions

`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`

Get a list of subscription status definitions from the account.

## Query parameters

- `businessUnitId` integer
- `includeTranslations` boolean

## Response `200`

successful operation

- ActionResponseWithResultsSubscriptionDefinition
  - `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: A string that categorizes the type of error.
    - `context` object, required: An object containing additional context about the error condition, with keys as context names and values as arrays of strings.
    - `errors` ErrorDetail[], required: An array of ErrorDetail objects providing further information about the error.
      - `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: A string representing the unique identifier of the error.
    - `links` object, required: An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps.
    - `message` string, required: A string containing a human-readable message describing the error.
    - `status` string, required: A string indicating the status of the error.
    - `subCategory` object: An object providing more specific categorization of the error.
  - `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` SubscriptionDefinition[], 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` PublicSubscriptionTranslation[]: 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

- **2026-09-03** (2026-09) `e1706f57adc0`: 3 breaking, 6 info
  - the `results/items/subscriptionTranslations/items/createdAt` response's property format changed from `int32` to `int64` for status `200`
  - the `results/items/subscriptionTranslations/items/subscriptionId` response's property format changed from `int32` to `int64` for status `200`
  - the `results/items/subscriptionTranslations/items/updatedAt` response's property format changed from `int32` to `int64` for status `200`
  - the endpoint scheme security `private_apps` was removed from the API
  - …5 more

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

---

[API](https://skmtc.dev/hubspot/apis/communication-preferences-subscriptions.md) - [All operations](https://skmtc.dev/hubspot/apis/communication-preferences-subscriptions/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/communication-preferences-subscriptions/revisions/7a38d643f718?raw)
