DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List all sections

Example Request & Response (Single Language Help Center)

$ curl https://api.intercom.io/help_center/sections \
-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": "section",
      "workspace_id": "abcdef",
      "name": "Section 1",
      "created_at": 123456,
      "updated_at": 123456,
      "parent_id": "1",
      "url": "http://intercom.test/help/section/section-1",
      "icon": "http://intercom/help_center/icon-1",
      "parent_id": "1",
      "order": 0,
      "default_locale": "en",
      "translated_content": {
        "type": "group_translated_content",
        "es": {
            "type": "group_content",
          "name": "Sección 1"
        }
      }
    },
    {
      "id": 2,
      "type": "section",
      "workspace_id": "abcdef",
      "name": "Section 2",
      "created_at": 123456,
      "updated_at": 123456,
            "parent_id": "1",
      "url": "http://intercom.test/help/section/section-1",
      "icon": "http://intercom/help_center/icon-1",
      "parent_id": "1",
      "order": 0,
      "default_locale": "en",
      "translated_content": {
        "type": "group_translated_content",
        "es": {
            "type": "group_content",
          "name": "Sección 2"
        }
      }
    }
  ]
}

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

Response

Key

Type

Description

type

String

The type of object - list.

pages

Object

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

total_count

Integer

A count of the total number of sections.

data

Array

An array of Section objects

📘

How are the sections sorted and ordered?

Sections 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 sections first.