Home
/
REST API Reference
/
Companies
/
List attached segments for companies

List attached segments for companies

You can fetch a list of all segments that belong to a company.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
string

The unique identifier for the company which is given by Intercom

Example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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" "Unstable"
Example: 2.10
get
/companies/{id}/segments
Request samples
Responses
200
Successful
Response Schema: application/json
type
string 
The type of object - list
 Value: "list"  
Array of objects (Segment)  
An array containing Segment Objects
 
401
Unauthorized
404
Company Not Found
Response samples
application/json
{
"type": "list",
"data": [ ]
}