younifyd
Menu

List Segments For A Contact

List attached segments for contact

GET/contacts/{contact_id}/segments

Use it in a workflow

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

Request

Path parameters

contact_idstringrequired

The unique identifier for the contact which is given by Intercom

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 {{listSegmentsForAContact.response.data.<field>}}.

typestring

The type of the object

One oflist

dataarray<object>

Segment objects associated with the contact.

typestring

The type of object.

One ofsegment

idstring

The unique identifier representing the segment.

namestring

The name of the segment.

created_atinteger

The time the segment was created.

updated_atinteger

The time the segment was updated.

person_typestring

Type of the contact: contact (lead) or user.

One ofcontactuser

countinteger

The number of items in the user segment. It's returned when `include_count=true` is included in the request.

json
{
  "type": "list",
  "data": [
    {
      "type": "segment",
      "id": "56203d253cba154d39010062",
      "name": "Active",
      "created_at": 1394621988,
      "updated_at": 1394622004,
      "person_type": "contact",
      "count": 3
    }
  ]
}

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