Home
/
REST API Reference
/
Models
/
App

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

Models

Admin

Admins are the teammate accounts that have access to a workspace

typestringrequired

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

Value"admin"
Example: "admin"
idstringrequired

The id representing the admin.

Example: "1295"
namestringrequired

The name of the admin.

Example: "Hoban Washburne"
emailstringrequired

The email of the admin.

Example: "wash@serenity.io"
job_titlestringrequired

The job title of the admin.

Example: "Philosopher"
away_mode_enabledbooleanrequired

Identifies if this admin is currently set in away mode.

Example: false
away_mode_reassignbooleanrequired

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

Example: false
has_inbox_seatbooleanrequired

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

Example: true
team_idsArray of integersrequired

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(App)

App is a workspace on Intercom

{
  "type": "admin",
  "id": "1295",
  "name": "Hoban Washburne",
  "email": "wash@serenity.io",
  "job_title": "Philosopher",
  "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

typestringrequired
Default "app"
Example: "app"
id_codestringrequired

The id of the app.

Example: "xyz789"
namestringrequired

The name of the app.

Example: "ACME"
regionstringrequired

The Intercom region the app is located in.

Example: "US"
timezonestringrequired

The timezone of the region where the app is located.

Example: "America/Los_Angeles"
created_atintegerrequired

When the app was created.

Example: 1671465577
identity_verificationbooleanrequired

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.

typestringrequired

The type of object - article_content .

Value"article_content"
Example: "article_content"
titlestringrequired

The title of the article.

Example: "How to create a new article"
descriptionstringrequired

The description of the article.

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

The body of the article.

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

The ID of the author of the article.

Example: "5017691"
statestringrequired

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