Skip to content
Home/
REST API Reference
/
/
Retrieve a Help Center

Intercom API (2.9)

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

Delete a collection

Request

You can delete a single collection by making a DELETE request to https://api.intercom.io/collections/<id>.

Security
bearerAuth
Path
idintegerrequired

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

Example: 123
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.9
curl -i -X DELETE \
  https://api.intercom.io/help_center/collections/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

successful

Bodyapplication/json
idstring

The unique identifier for the collection which you provided in the URL.

Example: "6890762"
objectstring

The type of object which was deleted. - collection

Value"collection"
Example: "collection"
deletedboolean

Whether the collection was deleted successfully or not.

Example: true
Response
application/json
{
  "id": "184",
  "object": "collection",
  "deleted": true
}

Retrieve a Help Center

Request

You can fetch the details of a single Help Center by making a GET request to https://api.intercom.io/help_center/help_center/<id>.

Security
bearerAuth
Path
idintegerrequired

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

Example: 123
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.9
curl -i -X GET \
  https://api.intercom.io/help_center/help_centers/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

Collection found

Bodyapplication/json
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"
urlstring

The URL for the help center, if you have a custom domain then this will show the URL using the custom domain.

Example: "https://intercom.help/mycompany"
custom_domainstring or null

Custom domain configured for the help center

Example: "help.mycompany.com"
Response
application/json
{
  "id": "103",
  "workspace_id": "this_is_an_id91_that_should_be_at_least_4",
  "created_at": 1717021361,
  "updated_at": 1717021361,
  "identifier": "help-center-1",
  "website_turned_on": false,
  "display_name": "Intercom Help Center",
  "url": "https://help.mycompany.com",
  "custom_domain": "help.mycompany.com"
}

List all Help Centers

Request

You can list all Help Centers by making a GET request to https://api.intercom.io/help_center/help_centers.

Security
bearerAuth
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example: 2.9
curl -i -X GET \
  https://api.intercom.io/help_center/help_centers \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

Help Centers found

Bodyapplication/json
typestring

The type of the object - list.

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

An array of Help Center objects

Response
application/json
{
  "type": "list",
  "data": []
}

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