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

# Retrieve a contact's unsubscribed status

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

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

- CommunicationPreferencesActionResponseWithResultsPublicWideStatus
  - `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 — 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 — 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` CommunicationPreferencesPublicWideStatus[], 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.

---

[API](https://skmtc.net/hubspot/apis/hubspot-api-specification.md) · [All operations](https://skmtc.net/hubspot/apis/hubspot-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubspot/hubspot-api-specification/versions/f9c7181056c5/schema)
