Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Segments

Retrieve a segment

You can fetch the details of a single segment.

get/segments/{segment_id}

Path parameters

segment_idstring required

The unique identified of a given segment.

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 response

type'segment'

The type of object.

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_type'contact' | 'user'

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

countinteger nullable

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

Example response

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