Home
/
REST API Reference
/
Models
/
App

Intercom API (2.13)

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

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

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

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

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 States

Everything about your ticket states

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

Admin

Admins are the teammate accounts that have access to a workspace

typestring

String representing the object's type. Always has the value admin.

Example: "admin"
idstring

The id representing the admin.

Example: "1295"
namestring

The name of the admin.

Example: "Joe Example"
emailstring

The email of the admin.

Example: "jdoe@example.com"
job_titlestring

The job title of the admin.

Example: "Associate"
away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

Example: false
away_mode_reassignboolean

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example: false
has_inbox_seatboolean

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example: true
team_idsArray of integers

This is a list of ids of the teams that this admin is part of.

Example: [814865]
avatarobject

This object represents the avatar associated with the admin.

email_verifiedboolean or null

Identifies if this admin's email is verified.

Example: true
appobject or null(App)

App is a workspace on Intercom

{
  "type": "admin",
  "id": "1295",
  "name": "Joe Example",
  "email": "jdoe@example.com",
  "job_title": "Associate",
  "away_mode_enabled": false,
  "away_mode_reassign": false,
  "has_inbox_seat": true,
  "team_ids": [
    814865
  ],
  "avatar": {
    "type": "avatar",
    "image_url": "https://example.com/avatar.png"
  },
  "email_verified": true,
  "app": {
    "type": "app",
    "id_code": "xyz789",
    "name": "ACME",
    "region": "US",
    "timezone": "America/Los_Angeles",
    "created_at": 1671465577,
    "identity_verification": false
  }
}

App

App is a workspace on Intercom

typestring
Default "app"
Example: "app"
id_codestring

The id of the app.

Example: "xyz789"
namestring

The name of the app.

Example: "ACME"
regionstring

The Intercom region the app is located in.

Example: "US"
timezonestring

The timezone of the region where the app is located.

Example: "America/Los_Angeles"
created_atinteger

When the app was created.

Example: 1671465577
identity_verificationboolean

Whether or not the app uses identity verification.

Example: false
{
  "type": "app",
  "id_code": "xyz789",
  "name": "ACME",
  "region": "US",
  "timezone": "America/Los_Angeles",
  "created_at": 1671465577,
  "identity_verification": false
}

Article Content

The Content of an Article.

typestring or null

The type of object - article_content .

Enumnull"article_content"
Example: "article_content"
titlestring

The title of the article.

Example: "How to create a new article"
descriptionstring

The description of the article.

Example: "This article will show you how to create a new article."
bodystring

The body of the article.

Example: "This is the body of the article."
author_idinteger

The ID of the author of the article.

Example: "5017691"
statestring

Whether the article is published or is a draft .

Enum"published""draft"
Example: "draft"
created_atinteger(date-time)

The time when the article was created (seconds).

Example: 1663597223
updated_atinteger(date-time)

The time when the article was last updated (seconds).

Example: 1663597260
urlstring

The URL of the article.

Example: "http://intercom.test/help/en/articles/3-default-language"
{
  "type": "article_content",
  "title": "How to create a new article",
  "description": "This article will show you how to create a new article.",
  "body": "This is the body of the article.",
  "author_id": "5017691",
  "state": "draft",
  "created_at": 1663597223,
  "updated_at": 1663597260,
  "url": "http://intercom.test/help/en/articles/3-default-language"
}