Intercom: List All Collections

List the Help Center collections in Intercom.

Tool ID: intercom_list_all_collections

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_all_collections',
  {},
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_list_all_collections --input '{}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "list",
    "pages": {
      "type": "pages",
      "page": 123,
      "next": {
        "per_page": 123,
        "starting_after": "cursor_123"
      }
    },
    "total_count": 123
  }
}

Use deepline describe intercom_list_all_collections --json for the latest machine-readable contract.

Input reference

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. This action requires no input fields.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	This will return a list of Collections for the App.
`result.data.type`	`"list"`	No	—	The type of the object - `list`. Allowed: `list`.
`result.data.pages`	`object \| null`	No	—	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.
`result.data.pages.type`	`"pages"`	No	—	the type of object `pages`. Allowed: `pages`.
`result.data.pages.page`	`integer`	No	—	The current page
`result.data.pages.next`	`object \| null`	No	—	—
`result.data.pages.next.per_page`	`integer`	No	—	The number of results to fetch per page.
`result.data.pages.next.starting_after`	`string \| null`	No	—	The cursor to use in the next request to get the next page of results.
`result.data.pages.per_page`	`integer`	No	—	Number of results per page
`result.data.pages.total_pages`	`integer`	No	—	Total number of pages
`result.data.total_count`	`integer`	No	—	A count of the total number of collections.
`result.data.data`	`array`	No	—	An array of collection objects
`result.data.data[].id`	`string`	No	—	The unique identifier for the collection which is given by Intercom.
`result.data.data[].workspace_id`	`string`	No	—	The id of the workspace which the collection belongs to.
`result.data.data[].name`	`string`	No	—	The name of the collection. For multilingual collections, this will be the name of the default language’s content.
`result.data.data[].description`	`string \| null`	No	—	The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.
`result.data.data[].created_at`	`integer`	No	—	The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language’s content. Format: `date-time`.
`result.data.data[].updated_at`	`integer`	No	—	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. Format: `date-time`.
`result.data.data[].url`	`string \| null`	No	—	The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.
`result.data.data[].icon`	`string \| null`	No	—	The icon of the collection.
`result.data.data[].order`	`integer`	No	—	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.
`result.data.data[].default_locale`	`string`	No	—	The default locale of the help center. This field is only returned for multilingual help centers.
`result.data.data[].translated_content`	`object \| null`	No	—	The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.
`result.data.data[].translated_content.type`	`null \| "group_translated_content"`	No	—	The type of object - group_translated_content. Allowed: `null`, `group_translated_content`.
`result.data.data[].translated_content.ar`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.ar.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.data[].translated_content.ar.name`	`string`	No	—	The name of the collection or section.
`result.data.data[].translated_content.ar.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.data[].translated_content.bg`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.bg.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.data[].translated_content.bg.name`	`string`	No	—	The name of the collection or section.
`result.data.data[].translated_content.bg.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.data[].translated_content.bs`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.bs.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.data[].translated_content.bs.name`	`string`	No	—	The name of the collection or section.
`result.data.data[].translated_content.bs.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.data[].translated_content.ca`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.ca.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.data[].translated_content.ca.name`	`string`	No	—	The name of the collection or section.
`result.data.data[].translated_content.ca.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.data[].translated_content.cs`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.cs.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.data[].translated_content.cs.name`	`string`	No	—	The name of the collection or section.
`result.data.data[].translated_content.cs.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.data[].translated_content.da`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.da.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.
`result.data.data[].translated_content.da.name`	`string`	No	—	The name of the collection or section.
`result.data.data[].translated_content.da.description`	`string`	No	—	The description of the collection. Only available for collections.
`result.data.data[].translated_content.de`	`object \| null`	No	—	The Content of a Group.
`result.data.data[].translated_content.de.type`	`null \| "group_content"`	No	—	The type of object - `group_content` . Allowed: `null`, `group_content`.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe intercom_list_all_collections --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation