Retrieve Segment

Retrieve a segment

GET/segments/{segment_id}

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the Retrieve Segment action (under Segments).
Fill in the fields below, then reference the result from later steps as {{retrieveSegment.response.data}}.

Request

Path parameters

segment_idstringrequired

The unique identified of a given segment.

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

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": "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.

Was this page helpful?