Skip to content
Home
/
REST API Reference
/
Models
/
Contact Archived

Intercom API (2.11)

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

Company Scroll

Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.

typestringrequired

The type of object - list

Value"list"
Example: "list"
dataArray of objects(Company)required
data[].​typestring

Value is company

Value"company"
Example: "company"
data[].​idstringrequired

The Intercom defined id representing the company.

Example: "531ee472cce572a6ec000006"
data[].​namestringrequired

The name of the company.

Example: "Blue Sun"
data[].​app_idstringrequired

The Intercom defined code of the workspace the company is associated to.

Example: "ecahpwf5"
data[].​planobject
data[].​company_idstringrequired

The company id you have defined for the company.

Example: "6"
data[].​remote_created_atintegerrequired

The time the company was created by you.

Example: 1663597223
data[].​created_atintegerrequired

The time the company was added in Intercom.

Example: 1663597223
data[].​updated_atintegerrequired

The last time the company was updated.

Example: 1663597223
data[].​last_request_atintegerrequired

The time the company last recorded making a request.

Example: 1663597223
data[].​sizeintegerrequired

The number of employees in the company.

Example: 100
data[].​websitestringrequired

The URL for the company website.

Example: "https://www.intercom.com"
data[].​industrystringrequired

The industry that the company operates in.

Example: "Software"
data[].​monthly_spendintegerrequired

How much revenue the company generates for your business.

Example: 100
data[].​session_countintegerrequired

How many sessions the company has recorded.

Example: 100
data[].​user_countintegerrequired

The number of users in the company.

Example: 100
data[].​custom_attributesobject

The custom attributes you have set on the company.

Example: {"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}
data[].​tagsobject

The list of tags associated with the company

data[].​segmentsobject

The list of segments associated with the company

pagesobject(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

total_countinteger or nullrequired

The total number of companies

Example: 100
scroll_paramstring

The scroll parameter to use in the next request to fetch the next page of results.

Example: "25b649f7-4d33-4ef6-88f5-60e5b8244309"
{
  "type": "list",
  "data": [
    { … }
  ],
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 100,
  "scroll_param": "25b649f7-4d33-4ef6-88f5-60e5b8244309"
}

Contact Archived

archived contact object

typestringrequired

always contact

Value"contact"
Example: "contact"
idstringrequired

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

Example: "5ba682d23d7cf92bef87bfd4"
external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"
archivedbooleanrequired

Whether the contact is archived or not.

Example: true
{
  "type": "contact",
  "id": "5ba682d23d7cf92bef87bfd4",
  "external_id": "f3b87a2e09d514c6c2e79b9a",
  "archived": true
}

Contact Attached Companies

A list of Company Objects

typestringrequired

The type of object

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

An array containing Company Objects

companies[].​typestring

Value is company

Value"company"
Example: "company"
companies[].​idstringrequired

The Intercom defined id representing the company.

Example: "531ee472cce572a6ec000006"
companies[].​namestringrequired

The name of the company.

Example: "Blue Sun"
companies[].​app_idstringrequired

The Intercom defined code of the workspace the company is associated to.

Example: "ecahpwf5"
companies[].​planobject
companies[].​company_idstringrequired

The company id you have defined for the company.

Example: "6"
companies[].​remote_created_atintegerrequired

The time the company was created by you.

Example: 1663597223
companies[].​created_atintegerrequired

The time the company was added in Intercom.

Example: 1663597223
companies[].​updated_atintegerrequired

The last time the company was updated.

Example: 1663597223
companies[].​last_request_atintegerrequired

The time the company last recorded making a request.

Example: 1663597223
companies[].​sizeintegerrequired

The number of employees in the company.

Example: 100
companies[].​websitestringrequired

The URL for the company website.

Example: "https://www.intercom.com"
companies[].​industrystringrequired

The industry that the company operates in.

Example: "Software"
companies[].​monthly_spendintegerrequired

How much revenue the company generates for your business.

Example: 100
companies[].​session_countintegerrequired

How many sessions the company has recorded.

Example: 100
companies[].​user_countintegerrequired

The number of users in the company.

Example: 100
companies[].​custom_attributesobject

The custom attributes you have set on the company.

Example: {"paid_subscriber":true,"monthly_spend":155.5,"team_mates":9}
companies[].​tagsobject

The list of tags associated with the company

companies[].​segmentsobject

The list of segments associated with the company

total_countintegerrequired

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
  }
}