List all segments

You can fetch a list of all segments.

SecurityHTTP: bearerAuth
Request
query Parameters
include_count
boolean

It includes the count of contacts that belong to each segment.

Example: include_count=true
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "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" "Unstable"
Example: 2.11
get
/segments
Request samples
Responses

200

Successful response

Response Schema: application/json
type
string

The type of the object

Value: "segment.list"
Array of objects (Segment)

A list of Segment objects

pages
object

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

401

Unauthorized

Response samples
application/json
{ "type": "segment.list", "segments": [ ] }