---
title: "Retrieve a contact's unsubscribed status"
method: GET
path: "/communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all"
tags: ["Status"]
---

# Retrieve a contact's unsubscribed status

`GET /communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all`

## Request

- Base URL: `https://api.hubapi.com`
- URL: `https://api.hubapi.com/communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all`
- 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`

Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response `results` array will be empty.

## Path parameters

- `subscriberIdString` string, required

## Query parameters

- `channel` 'EMAIL', required
- `businessUnitId` integer
- `verbose` boolean

## Response `200`

successful operation

- ActionResponseWithResultsPublicWideStatus
  - `completedAt` string, date-time, required: The date and time when the operation was completed.
  - `errors` StandardError[]: An array of error objects detailing any issues encountered 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: An object containing related links, where each key is a link name and each value is a URL.
  - `numErrors` integer: The number of errors encountered during the operation.
  - `requestedAt` string, date-time: The date and time when the request was made.
  - `results` PublicWideStatus[], required: An array containing the results of the operation.
    - `businessUnitId` integer: The ID of the business unit associated with the status.
    - `channel` 'EMAIL', required: The type of communication channel, with 'EMAIL' as the only supported option.
    - `status` 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED', required: The subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
    - `subscriberIdString` string, required: The email address of the contact.
    - `timestamp` string, date-time, required: The date and time when the status was recorded.
    - `wideStatusType` 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE', required: The type of wide status, which can be 'PORTAL_WIDE' or 'BUSINESS_UNIT_WIDE'.
  - `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`: 6 info
  - the endpoint scheme security `private_apps` was removed from the API
  - the endpoint scheme security `private_apps` was removed from the API
  - the security scope `communication_preferences.read_write` was added to the endpoint's security scheme `oauth2`
  - the security scope `communication_preferences.read` was removed from the endpoint's security scheme `oauth2`
  - …2 more

[Operation history](https://skmtc.dev/hubspot/apis/communication-preferences-subscriptions/changes/communication-preferences/2026-09/statuses/:subscriberIdString/unsubscribe-all/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)