Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Contacts
Subscription Types

List subscriptions for a contact

You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. This will return a list of Subscription Type objects that the contact is associated with.

The data property will show a combined list of:

1.Opt-out subscription types that the user has opted-out from. 2.Opt-in subscription types that the user has opted-in to receiving.

Note: This endpoint only returns subscriptions where the contact has explicitly configured their preference. Subscriptions that are in the default state — where the contact has not made an explicit opt-in or opt-out choice — are not included in the response.

get/contacts/{contact_id}/subscriptions

Path parameters

contact_idstring required

The unique identifier for the contact which is given by Intercom

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Successful

type'list'

The type of the object

Example response

{
  "type": "list",
  "data": [
    {
      "type": "subscription",
      "id": "123456",
      "state": "live",
      "default_translation": {
        "name": "Announcements",
        "description": "Offers, product and feature announcements",
        "locale": "en"
      },
      "translations": [
        {
          "name": "Announcements",
          "description": "Offers, product and feature announcements",
          "locale": "en"
        }
      ],
      "consent_type": "opt_in",
      "content_types": [
        "email"
      ]
    }
  ]
}