Intercom API (unofficial showcase)
GET/help_center/collections/{collection_id}

Retrieve a help center collection

Retrieves a collection from the help center. Provide its identifier to get details such as its name, description, URL, and parent collection. Use the collection identifier assigned by Intercom.

2 parameters
collection_idintegerrequired
The unique integer identifier assigned to the collection you want to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; listed supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the collection, including its identifier, name, description, URL, hierarchy, timestamps, and translated content.
idstringoptional
The unique identifier for the collection which is given by Intercom.
workspace_idstringoptional
The id of the workspace which the collection belongs to.
namestringoptional
The name of the collection. For multilingual collections, this will be the name of the default language's content.
descriptionstringoptional
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
created_atintegeroptional
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
updated_atintegeroptional
The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.
urlstringoptional
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
iconstringoptional
The icon of the collection.
orderintegeroptional
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.
default_localestringoptional
The default locale of the help center. This field is only returned for multilingual help centers.
translated_contentobjectoptional
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
parent_idstringoptional
The id of the parent collection. If `null` then it is the first level collection.
help_center_idintegeroptional
The id of the help center the collection is in.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the collection is not found.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized, and a 404 is returned when the collection is not found. The collection_id path parameter must identify an existing collection.