Skip to content
Home/
REST API Reference
/
/
Contact companies

Intercom API (2.9)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Contact Attached Companies

A list of Company Objects

typestring

The type of object

Value"list"
Example: "list"
companiesArray of objects(Company)

An array containing Company Objects

total_countinteger

The total number of companies associated to this contact

Example: 100
pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

{
  "type": "list",
  "companies": [
    { … }
  ],
  "total_count": 100,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  }
}

Contact companies

An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.

dataArray of objects(Company Data)

An array of company data objects attached to the contact.

urlstring(uri)

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/companies"
total_countinteger

Int representing the total number of companyies attached to this contact

Example: 100
has_moreboolean

Whether there's more Addressable Objects to be viewed. If true, use the url to view all

Example: true
{
  "data": [
    { … }
  ],
  "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies",
  "total_count": 100,
  "has_more": true
}

Company Data

An object containing data about the companies that a contact is associated with.

idstring

The unique identifier for the company which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"
typestring

The type of the object. Always company.

Value"company"
Example: "company"
urlstring(uri)

The relative URL of the company.

Example: "/companies/5ba682d23d7cf92bef87bfd4"
{
  "id": "5ba682d23d7cf92bef87bfd4",
  "type": "company",
  "url": "/companies/5ba682d23d7cf92bef87bfd4"
}