Status

Get subscription preferences for a specific contact

Retrieve a contact's current email subscription preferences.

get/communication-preferences/2026-09/statuses/{subscriberIdString}

Request

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

subscriberIdStringstring required

The unique identifier of the subscriber whose communication preferences status is being retrieved.

channel'EMAIL' required

The communication channel for which the subscription status is being retrieved. Must be 'EMAIL'.

businessUnitIdinteger

The ID of the business unit to filter the subscription status. This is an optional parameter.

successful operation

completedAtstring date-time required

The date and time when the operation was completed.

linksobject

Contains URLs related to the response, such as documentation or resources.

numErrorsinteger

The number of errors that occurred during the operation.

requestedAtstring date-time

The date and time when the request was made.

startedAtstring date-time required

The date and time when the operation started.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.