The intercom API reference.
The intercom API reference.
Collections are top level containers for Articles within the Help Center.
The unique identifier for the collection which is given by Intercom.
The id of the workspace which the collection belongs to.
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
The id of the parent collection. If null
then it is the first level collection.
{ "id": "6871119", "workspace_id": "hfi1bx4l", "name": "Default language name", "description": "Default language description", "created_at": 1672928359, "updated_at": 1672928610, "url": "http://intercom.test/help/collection/name", "icon": "book-bookmark", "order": "1", "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": { … } }, "parent_id": "6871118", "help_center_id": "123" }
Help Centers contain collections
The unique identifier for the Help Center which is given by Intercom.
The id of the workspace which the Help Center belongs to.
The identifier of the Help Center. This is used in the URL of the Help Center.
Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
{ "id": "123", "workspace_id": "hfi1bx4l", "created_at": 1672928359, "updated_at": 1672928610, "identifier": "intercom", "website_turned_on": true, "display_name": "Intercom Help Center" }
A list of Help Centers belonging to the App
An array of Help Center objects
The unique identifier for the Help Center which is given by Intercom.
The id of the workspace which the Help Center belongs to.
The time when the Help Center was created.
The time when the Help Center was last updated.
The identifier of the Help Center. This is used in the URL of the Help Center.
Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
{ "type": "list", "data": [ { … } ] }
You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections
.
Collections will be returned in descending order on the updated_at
attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.
curl -i -X GET \
'https://api.intercom.io/help_center/collections?page=0&per_page=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
Successful
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
An array of collection objects
The unique identifier for the collection which is given by Intercom.
The id of the workspace which the collection belongs to.
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
The id of the parent collection. If null
then it is the first level collection.
{ "type": "list", "data": [ { … }, { … } ], "total_count": 2, "pages": { "type": "pages", "page": 1, "per_page": 20, "total_pages": 1 } }
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual collections, this will be the description of the default language's content.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
The id of the parent collection. If null
then it will be created as the first level collection.
curl -i -X POST \
https://api.intercom.io/help_center/collections \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"name": "Thanks for everything"
}'
collection created
The unique identifier for the collection which is given by Intercom.
The id of the workspace which the collection belongs to.
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
The id of the parent collection. If null
then it is the first level collection.
{ "id": "165", "workspace_id": "this_is_an_id69_that_should_be_at_least_4", "name": "Thanks for everything", "url": "http://help-center.test/myapp-69/", "order": 1, "created_at": 1719492721, "updated_at": 1719492721, "description": "", "icon": "book-bookmark", "parent_id": null, "help_center_id": 81 }
curl -i -X GET \
'https://api.intercom.io/help_center/collections/{collection_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
Collection found
The unique identifier for the collection which is given by Intercom.
The id of the workspace which the collection belongs to.
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
The id of the parent collection. If null
then it is the first level collection.
{ "id": "170", "workspace_id": "this_is_an_id75_that_should_be_at_least_4", "name": "English collection title", "url": "http://help-center.test/myapp-75/collection-22", "order": 22, "created_at": 1719492723, "updated_at": 1719492723, "description": "english collection description", "icon": "bookmark", "parent_id": null, "help_center_id": 84 }
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual collections, this will be the description of the default language's content.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
curl -i -X PUT \
'https://api.intercom.io/help_center/collections/{collection_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"name": "Update collection name"
}'
successful
The unique identifier for the collection which is given by Intercom.
The id of the workspace which the collection belongs to.
The name of the collection. For multilingual collections, this will be the name of the default language's content.
The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.
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.
The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
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.
The default locale of the help center. This field is only returned for multilingual help centers.
The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
The id of the parent collection. If null
then it is the first level collection.
{ "id": "176", "workspace_id": "this_is_an_id81_that_should_be_at_least_4", "name": "Update collection name", "url": "http://help-center.test/myapp-81/collection-25", "order": 25, "created_at": 1719492724, "updated_at": 1719492724, "description": "english collection description", "icon": "folder", "parent_id": null, "help_center_id": 87 }
curl -i -X DELETE \
'https://api.intercom.io/help_center/collections/{collection_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
{ "id": "182", "object": "collection", "deleted": true }
curl -i -X GET \
'https://api.intercom.io/help_center/help_centers/{help_center_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
Collection found
The unique identifier for the Help Center which is given by Intercom.
The id of the workspace which the Help Center belongs to.
The identifier of the Help Center. This is used in the URL of the Help Center.
Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
{ "id": "93", "workspace_id": "this_is_an_id93_that_should_be_at_least_4", "created_at": 1719492727, "updated_at": 1719492727, "identifier": "help-center-1", "website_turned_on": false, "display_name": "Intercom Help Center" }
curl -i -X GET \
'https://api.intercom.io/help_center/help_centers?page=0&per_page=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
Help Centers found
An array of Help Center objects
The unique identifier for the Help Center which is given by Intercom.
The id of the workspace which the Help Center belongs to.
The time when the Help Center was created.
The time when the Help Center was last updated.
The identifier of the Help Center. This is used in the URL of the Help Center.
Whether the Help Center is turned on or not. This is controlled in your Help Center settings.
{ "type": "list", "data": [] }