GetSubscription

Get subscription

get/subscription

Query parameters

channelIdstring required

The Channel ID (required).

subscriptionIdstring

The subscription ID. Location: query parameter. Use this for direct subscription lookup in the given channel.

attributeIdstring

Channel attribute ID. Only supports "user_id". Must be used together with attributeValue.

attributeValuestring

Subscription attribute value. Required when using attributeId.

emailAddressstring

Subscription email address to search for.

fieldsstring[]

Optional query parameter. Provide the subscription fields to include (can contain: customAttributes, tags, topics, segments, country, language, createdAt, clickedDates). If omitted, the full subscription is returned. Wait time until response will increase if more fields will be requested.

Response

Success-Response:

Theobject required

<p>subscription</p>

Changes

No recorded changes to this endpoint across all 1 revision of this API.