Intercom API (unofficial showcase)
GET/help_center/collections

List help center collections

Lists collections in the help center app. Use the results to review collection details, including their names, descriptions, and parent collections. Collections are ordered by updated_at in descending order, with the most recently updated first.

1 parameter
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

2 status codes
200Returns a list of collection objects with total-count and cursor-based pagination metadata; collections are ordered by update time, most recently updated first.
typestringoptional
The type of the object - `list`.
Allowed:list
pagesobjectoptional
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.
total_countintegeroptional
A count of the total number of collections.
dataarray<Collection>optional
An array of collection objects
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

Error handling

A 401 is returned when the request is unauthorized. Send valid authentication credentials to access the collections.