Home
/
REST API Reference
/
Segments
/
Retrieve a segment

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL https://developers.intercom.com
License MIT
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Segment

A segment is a group of your contacts defined by the rules that you set.

typestring

The type of object.

Value"segment"
Example: "segment"
idstring

The unique identifier representing the segment.

Example: "56203d253cba154d39010062"
namestring

The name of the segment.

Example: "Active"
created_atinteger

The time the segment was created.

Example: 1394621988
updated_atinteger

The time the segment was updated.

Example: 1394622004
person_typestring

Type of the contact: contact (lead) or user.

Enum"contact""user"
Example: "contact"
countinteger or null

The number of items in the user segment. It's returned when include_count=true is included in the request.

Example: 3
{
  "type": "segment",
  "id": "56203d253cba154d39010062",
  "name": "Active",
  "created_at": 1394621988,
  "updated_at": 1394622004,
  "person_type": "contact",
  "count": 3
}

List attached segments for contact

Request

You can fetch a list of segments that are associated to a contact.

Path
contact_idstringrequired

The unique identifier for the contact which is given by Intercom

Example: 63a07ddf05a32042dffac965
Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.11
curl -i -X GET \
  'https://api.intercom.io/contacts/{contact_id}/segments' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

successful

Bodyapplication/json
typestring

The type of the object

Value"list"
Example: "list"
dataArray of objects(Segment)

Segment objects associated with the contact.

Response
application/json
{
  "type": "list",
  "data": [
    { … }
  ]
}

List all segments

Request

You can fetch a list of all segments.

Query
include_countboolean

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

Example: include_count=true
Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.11
curl -i -X GET \
  'https://api.intercom.io/segments?include_count=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

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
application/json
{
  "type": "segment.list",
  "segments": [
    { … },
    { … }
  ]
}

Retrieve a segment

Request

You can fetch the details of a single segment.

Path
idstringrequired

The unique identified of a given segment.

Example: 123
Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.11
curl -i -X GET \
  'https://api.intercom.io/segments/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'

Responses

Successful response

Bodyapplication/json
typestring

The type of object.

Value"segment"
Example: "segment"
idstring

The unique identifier representing the segment.

Example: "56203d253cba154d39010062"
namestring

The name of the segment.

Example: "Active"
created_atinteger

The time the segment was created.

Example: 1394621988
updated_atinteger

The time the segment was updated.

Example: 1394622004
person_typestring

Type of the contact: contact (lead) or user.

Enum"contact""user"
Example: "contact"
countinteger or null

The number of items in the user segment. It's returned when include_count=true is included in the request.

Example: 3
Response
application/json
{
  "type": "segment",
  "id": "667d61808a68186f43bafe5f",
  "name": "John segment",
  "created_at": 1719492992,
  "updated_at": 1719492992,
  "person_type": "user"
}

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models