List all collections

Request

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

Requires the read_articles_scope OAuth scope.

Security

bearerAuth

Query

pageinteger

The page of results to fetch. Defaults to the first page.

Example:page=1

per_pageinteger, <= 250

The number of results to return per page. Defaults to 20. Maximum is 250.

Example:per_page=20

help_center_idinteger

Only return collections that belong to this Help Center.

Example:help_center_id=123

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.17

curl -i -X GET \
  'https://api.intercom.io/help_center/collections?page=1&per_page=20&help_center_id=123' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.17'

Responses

Successful

Bodyapplication/json

typestring

The type of the object - list.

Value:"list"

Example:"list"

pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

total_countinteger

A count of the total number of collections.

Example:1

dataArray of objects(Collection)

An array of collection objects

Response

{
  "type": "list",
  "data": [
    { … },
    { … }
  ],
  "total_count": 2,
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  }
}