Home
/
REST API Reference
/
Help Center
/
Help Centers

Intercom API (2.7)

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

Help Center

Help Centers contain collections

idstring

The unique identifier for the Help Center which is given by Intercom.

Example: "123"
workspace_idstring

The id of the workspace which the Help Center belongs to.

Example: "hfi1bx4l"
created_atinteger(date-time)

The time when the Help Center was created.

Example: 1672928359
updated_atinteger(date-time)

The time when the Help Center was last updated.

Example: 1672928610
identifierstring

The identifier of the Help Center. This is used in the URL of the Help Center.

Example: "intercom"
website_turned_onboolean

Whether the Help Center is turned on or not. This is controlled in your Help Center settings.

Example: true
display_namestring

The display name of the Help Center only seen by teammates.

Example: "Intercom Help Center"
{
  "id": "123",
  "workspace_id": "hfi1bx4l",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "identifier": "intercom",
  "website_turned_on": true,
  "display_name": "Intercom Help Center"
}

Help Centers

A list of Help Centers belonging to the App

typestring

The type of the object - list.

Value"list"
Example: "list"
dataArray of objects(Help Center)

An array of Help Center objects

{
  "type": "list",
  "data": [
    { … }
  ]
}

Section

Sections are subdivisions of a collection, with a collection potentially having multiple sections.

typestring

The type of object - section.

Default "section"
Value"section"
Example: "section"
idstring

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

Example: "6871119"
workspace_idstring

The id of the workspace which the section belongs to.

Example: "hfi1bx4l"
namestring

The name of the section. For multilingual sections, this will be the name of the default language's content.

Example: "Default language name"
created_atinteger(date-time)

The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content.

Example: 1672928359
updated_atinteger(date-time)

The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content.

Example: 1672928610
urlstring or null

The URL of the section. For multilingual help centers, this will be the URL of the section for the default language.

Example: "http://intercom.test/help/section/name"
iconstring or null

The icon of the section.

Example: "book-bookmark"
orderinteger

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

Example: "1"
parent_idInteger (integer) or String (string)

The id of the parent section.

Example: 6871119
One of:

The id of the parent section.

integer(Integer)

The id of the parent section.

default_localestring

The default locale of the help center. This field is only returned for multilingual help centers.

Example: "en"
translated_contentobject or null(Group Translated Content)

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

{
  "type": "section",
  "id": "6871119",
  "workspace_id": "hfi1bx4l",
  "name": "Default language name",
  "created_at": 1672928359,
  "updated_at": 1672928610,
  "url": "http://intercom.test/help/section/name",
  "icon": "book-bookmark",
  "order": "1",
  "parent_id": 6871119,
  "default_locale": "en",
  "translated_content": {
    "type": "group_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  }
}

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

Visitors

Everything about your Visitors

Operations

Models