Intercom API (unofficial showcase)
GET/companies/{company_id}/segments

List segments attached to a company

Lists the segments associated with a specific company. Use the company identifier to retrieve the segments that belong to it.

2 parameters
company_idstringrequired
The unique identifier of the company whose attached segments you want to list.
Intercom-Versionstringoptional
API version to use for the request. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a list of segment objects associated with the company.
typestringoptional
The type of object - `list`
Allowed:list
dataarray<Segment>optional
An array containing Segment Objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the company does not exist.

One documented failure

  • company_not_found

    Company Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is not authorized. A 404 is returned when the company_id path parameter does not identify an existing company.