Intercom API (unofficial showcase)
GET/contacts/{contact_id}/subscriptions

List subscriptions for a contact

Lists the subscription types associated with a contact where the contact has explicitly set a preference. Use this endpoint to retrieve both opt-in and opt-out choices; subscription types in their default state are not included.

2 parameters
contact_idstringrequired
The unique identifier of the contact whose subscriptions to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use; the listed values include 1.0 through 2.6. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a list of subscription type objects for which the contact has explicitly opted in or opted out; default-state subscriptions are excluded.
typestringoptional
The type of the object
Allowed:list
dataarray<SubscriptionTypes>optional
A list of subscription type objects associated with the workspace .
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the contact is not found.

One documented failure

  • not_found

    User Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the contact identified by the contact_id path parameter is not found. The Intercom-Version header defaults to 2.17 when omitted.