List all segments

Request

You can fetch a list of all segments.

Security

bearerAuth

Query

include_countboolean

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

Example:include_count=true

Intercom-Versionstring(intercom_version)

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

Default:"2.9"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.9

curl -i -X GET \
  'https://api.intercom.io/segments?include_count=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

Successful response

Bodyapplication/json

typestring

The type of the object

Value:"segment.list"

Example:"segment.list"

segmentsArray of objects(Segment)

A list of Segment objects

pagesobject

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

Response

{
  "type": "segment.list",
  "segments": [
    { … },
    { … }
  ]
}