REST API Reference

Contact Unarchived

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

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

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

Models

Contact Tags

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

dataArray of objects(Addressable List)required

This object represents the tags attached to a contact.

data[].typestring(uri)required

The addressable object type

Example: "note"

data[].idstringrequired

The id of the addressable object

Example: "123"

data[].urlstring(uri)required

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"

urlstring(uri)required

url to get more tag resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/tags"

total_countintegerrequired

Int representing the total number of tags attached to this contact

Example: 100

has_morebooleanrequired

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

Example: true

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

Contact Unarchived

unarchived 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: false

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

Content Source List

typestringrequired

Value"content_source.list"

Example: "content_source.list"

total_countintegerrequired

The total number of content sources used by AI Agent in the conversation.

Example: 1

content_sourcesArray of objects(Content Source)required

The content sources used by AI Agent in the conversation.

content_sources[].content_typestringrequired

The type of the content source.

Enum"file""article""external_content""content_snippet""workflow_connector_action"

Example: "content_snippet"

content_sources[].urlstringrequired

The internal URL linking to the content source for teammates.

Example: "/fin-ai-agent/content?content=content_snippet&id=3234924"

content_sources[].titlestringrequired

The title of the content source.

Example: "My internal content snippet"

content_sources[].localestringrequired

The ISO 639 language code of the content source.

Example: "en"

{
  "type": "content_source.list",
  "total_count": 1,
  "content_sources": [
    { … }
  ]
}