The intercom API reference.
Intercom API (2.11)
https://api.intercom.io/
https://api.eu.intercom.io/
https://api.au.intercom.io/
Contact Archived
archived contact object
The unique identifier for the contact which is given by Intercom.
The unique identifier for the contact which is provided by the Client.
{ "type": "contact", "id": "5ba682d23d7cf92bef87bfd4", "external_id": "f3b87a2e09d514c6c2e79b9a", "archived": true }
Contact Attached Companies
A list of Company Objects
An array containing Company Objects
The Intercom defined id representing the company.
The Intercom defined code of the workspace the company is associated to.
The time the company was created by you.
The time the company was added in Intercom.
The time the company last recorded making a request.
The URL for the company website.
How much revenue the company generates for your business.
The custom attributes you have set on the company.
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.
Url to get more company resources for this contact
Int representing the total number of companyies attached to this contact
{ "data": [ { … } ], "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", "total_count": 100, "has_more": true }