younifyd
Menu

List Attached Segments For Companies

List attached segments for companies

GET/companies/{company_id}/segments

Use it in a workflow

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

Request

Path parameters

company_idstringrequired

The unique identifier for the company 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 {{listAttachedSegmentsForCompanies.response.data.<field>}}.

typestring

The type of object - `list`

One oflist

dataarray<object>

An array containing Segment Objects

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.