DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List all collections

Example Request & Response (Single Language Help Center)

$ curl https://api.intercom.io/help_center/collections \
-X GET \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
-H 'Content-Type: application/json' -d
HTTP/1.1 200 OK
{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  },
  "total_count": 2,
  "data": [
    {
      "id": 1,
      "type": "collection",
      "workspace_id": "abcdef",
      "name": "Collection 1",
      "description": "English description 1", 
      "created_at": 123456,
      "updated_at": 123456,
      "url": "http://intercom.test/help/collection/collection-1",
      "icon": "http://intercom/help_center/icon-1",
      "order": 0
    },
    {
      "id": 2,
      "type": "collection",
      "workspace_id": "abcdef",
      "name": "Collection 2",
      "description": "English description 2", 
      "created_at": 123456,
      "updated_at": 123456,
      "url": "http://intercom.test/help/collection/collection-2",
      "icon": "http://intercom/help_center/icon-1",
      "order": 1
    }
  ]
}

You can fetch a list of all collections by making a GET request to https://api.intercom.io/help_center/collections.

Response

Key

Type

Description

type

String

The type of object - list.

pages

Object

A Pages object with the information needed to paginate through collections.

total_count

Integer

A count of the total number of collections.

data

Array

An array of Collection objects.

📘

How are the collections sorted and ordered?

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.