younifyd
Menu

List Contact Banners

List banners for a contact

GET/contacts/{id}/banners

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the List Contact Banners action (under Banners).
  3. Fill in the fields below, then reference the result from later steps as {{listContactBanners.response.data}}.

Request

Path parameters

idstringrequired

The unique identifier of a contact.

Headers

Intercom-Versionstring

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

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{listContactBanners.response.data.<field>}}.

typestring

String representing the object's type. Always has the value `list`.

dataarray<object>

An array of banners.

typestring

String representing the object's type. Always has the value `banner`.

idstring

The id of the banner.

view_idstring

The id of the contact's view of this banner. Pass this to the dismiss endpoint to record a dismissal.

titlestring

The banner's title. `null` when the banner has no title.

bodystring

The banner's body content as HTML.

stylestring

How the banner is displayed.

positionstring

Where the banner is positioned.

show_dismiss_buttonboolean

Whether the banner should display a dismiss control.

actionobject6 fields

The action a contact can take on the banner, or `null` when the banner has no action. The fields present depend on `type`: `url` (`label`, `target`), `reaction` (`reaction_set`), `email_collector`, or `product_tour` (`tour_id`, `tour_url`).

client_targetingarray<object>

Reserved for future use. Always `null` in the current version — banners that depend on client-side targeting rules (such as page URL or time on page) are not returned by this endpoint.

created_atinteger (timestamp)

The time the contact's view of this banner was created.

json
{
  "type": "list",
  "data": [
    {
      "type": "banner",
      "id": "486517",
      "view_id": "645719311",
      "title": "Hi there",
      "body": "<p class=\"no-margin\">Hi there!</p>",
      "style": "inline",
      "position": "top",
      "show_dismiss_button": true,
      "action": {
        "type": "url",
        "label": "Learn more",
        "target": "https://www.intercom.com/pricing",
        "reaction_set": [
          {
            "index": 0,
            "unicode_emoticon": "👍"
          }
        ],
        "tour_id": "12345",
        "tour_url": "https://app.intercom.com/tours/12345"
      },
      "client_targeting": [
        {}
      ],
      "created_at": 1780580493
    }
  ]
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.