Intercom API (unofficial showcase)
GET/segments/{segment_id}

Retrieve a segment

Retrieves the details of a segment, a group of contacts defined by its rules. Use segment_id to identify the segment you want to retrieve.

2 parameters
segment_idstringrequired
The unique identifier of the segment to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a segment object containing its identifier, name, creation and update times, contact type, and other segment details.
typestringoptional
The type of object.
Allowed:segment
idstringoptional
The unique identifier representing the segment.
namestringoptional
The name of the segment.
created_atintegeroptional
The time the segment was created.
updated_atintegeroptional
The time the segment was updated.
person_typestringoptional
Type of the contact: contact (lead) or user.
Allowed:contactuser
countintegeroptional
The number of items in the user segment. It's returned when `include_count=true` is included in the request.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the segment is not found.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the segment identified by the segment_id path parameter is not found.