Home
/
REST API Reference
/
Segments
/
Retrieve a segment

Retrieve a segment

You can fetch the details of a single segment.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
string

The unique identified of a given segment.

Example: 123
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/{id}
Request samples
Responses
200
Successful response
Response Schema: application/json
type
string 
The type of object.
 Value: "segment"  
id
string 
The unique identifier representing the segment.
 
name
string 
The name of the segment.
 
created_at
integer 
The time the segment was created.
 
updated_at
integer 
The time the segment was updated.
 
person_type
string 
Type of the contact: contact (lead) or user.
 Enum: "contact" "user"  
count
integer or null 
The number of items in the user segment. It's returned when include_count=true is included in the request.
 
401
Unauthorized
404
Segment not found
Response samples
application/json
{
"type": "segment",
"id": "663a0374262d16a19645eed5",
"name": "John segment",
"created_at": 1715078004,
"updated_at": 1715078004,
"person_type": "user"
}