v51

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

List all segments

You can fetch a list of all segments.

get/segments

Query parameters

include_countboolean

It includes the count of contacts that belong to each 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.list'

The type of the object

pagesobject

A pagination object, which may be empty, indicating no further pages to fetch.

Example response

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