Skip to main content
GET
Retrieve a contact's unsubscribed status

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

subscriberIdString
string
required

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

Query Parameters

channel
enum<string>
required

The communication channel for which the unsubscribe status is being checked. Must be 'EMAIL'.

Available options:
EMAIL
businessUnitId
integer<int64>

An optional integer representing the business unit ID.

verbose
boolean
default:false

A boolean indicating whether to include detailed information. Defaults to false.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the operation was completed.

results
object[]
required

An array containing the results of the operation.

startedAt
string<date-time>
required

The date and time when the operation started.

status
enum<string>
required

The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

An array of error objects detailing any issues encountered during the operation.

An object containing related links, where each key is a link name and each value is a URL.

numErrors
integer<int32>

The number of errors encountered during the operation.

requestedAt
string<date-time>

The date and time when the request was made.

Last modified on September 9, 2026