DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List attached segments for companies

Example Request & Response

$ curl https://api.intercom.io/companies/<id>/segments \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
HTTP/1.1 200 OK
{
  "type": "list",
  "data": [
    {
      "type": "segment",
        "id": "53203e244cba153d39000062",
        "name": "New",
        "created_at": 1394621988,
        "updated_at": 1394622004
    }
  ]
}
Example Errors

HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "not_found",
      "message": "Company Not Found"
    }
  ]
}
}

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

Response

This will return a list of Segment objects.

Attribute

Type

Description

type

String

The type of object - list

data

Array

An array containing Segment Objects