Intercom API (unofficial showcase)
GET/segments

List segments

Lists segments in the workspace, which group contacts according to configured rules. Set include_count to include the number of contacts in each segment. Use page and per_page to paginate the results.

2 parameters
include_countbooleanoptional
Set to true to include the count of contacts in each segment.
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

2 status codes
200Returns a segment list containing segment objects and, when the response is paginated, a `pages` object.
typestringoptional
The type of the object
Allowed:segment.list
segmentsarray<Segment>optional
A list of Segment objects
pagesobjectoptional
A pagination object, which may be empty, indicating no further pages to fetch.
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

Error handling

A 401 is returned when the request is unauthorized. Set include_count to true to include contact counts for each segment.