DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List attached companies

Example Request & Response

$ curl https://api.intercom.io/contacts/<id>/companies \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
HTTP/1.1 200 OK
{
  "type": "company.list",
  "pages": {
    "type": "pages",
    "next": "https://api.intercom.io/contacts/5d010558220cf7d48317dbb9/companies?per_page=1&page=2",
    "page": 1,
    "per_page": 1,
    "total_pages": 2
  },
  "companies": [
    {
      "type": "company",
      "company_id": "5d2333ea82166f5838642267-qualification-company",
      "id": "5d2333ea82166f5838642266",
      "app_id": "ecahpwf5",
      "name": "Test",
      "created_at": 1562588138,
      "updated_at": 1565257230,
      "last_request_at": 1562588115,
      "monthly_spend": 0,
      "session_count": 0,
      "user_count": 1,
      "industry": "Test",
      "tags": {
        "type": "tag.list",
        "tags": []
      },
      "segments": {
        "type": "segment.list",
        "segments": []
      },
      "plan": {},
      "custom_attributes": {}
    }
  ],
  "total_count": 2
}
Example Errors

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

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

Request Path Parameter

Parameter

Type

Required

Description

id

String

Yes

The unique identifier for the contact which is given by Intercom

Response

This will return a paginated list of Company objects.

Attribute

Type

Description

type

String

The type of object - company.list

companies

Array

An array containing Company Objects

total_count

Integer

The total number of companies associated to this contact

pages

Pagination Object

The information needed to paginate through companies