Intercom: List Articles

List the Help Center articles in Intercom.

Tool ID: intercom_list_articles

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_articles',
  {},
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_list_articles --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_articles --json for the latest machine-readable contract.

Input reference

You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles. > 📘 How are the articles sorted and ordered? > > Articles 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 articles 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 articles 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 articles.
`result.data.data`	`array`	No	—	An array of Article objects
`result.data.data[].type`	`"article"`	No	`"article"`	The type of object - `article`. Allowed: `article`.
`result.data.data[].id`	`string`	No	—	The unique identifier for the article which is given by Intercom.
`result.data.data[].workspace_id`	`string`	No	—	The id of the workspace which the article belongs to.
`result.data.data[].title`	`string`	No	—	The title of the article. For multilingual articles, this will be the title of the default language’s content.
`result.data.data[].description`	`string \| null`	No	—	The description of the article. For multilingual articles, this will be the description of the default language’s content.
`result.data.data[].body`	`string \| null`	No	—	The body of the article in HTML. For multilingual articles, this will be the body of the default language’s content.
`result.data.data[].author_id`	`integer`	No	—	The id of the author of the article. For multilingual articles, this will be the id of the author of the default language’s content. Must be a teammate on the help center’s workspace.
`result.data.data[].state`	`"published" \| "draft"`	No	`"draft"`	Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language’s content. Allowed: `published`, `draft`.
`result.data.data[].created_at`	`integer`	No	—	The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language’s content in seconds. Format: `date-time`.
`result.data.data[].updated_at`	`integer`	No	—	The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language’s content in seconds. Format: `date-time`.
`result.data.data[].url`	`string \| null`	No	—	The URL of the article. For multilingual articles, this will be the URL of the default language’s content.
`result.data.data[].parent_id`	`integer \| null`	No	—	The id of the article’s parent collection or section. An article without this field stands alone.
`result.data.data[].parent_ids`	`array`	No	—	The ids of the article’s parent collections or sections. An article without this field stands alone.
`result.data.data[].parent_type`	`string \| null`	No	—	The type of parent, which can either be a `collection` or `section`.
`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 Article. The keys are the locale codes and the values are the translated content of the article.
`result.data.data[].translated_content.type`	`null \| "article_translated_content"`	No	—	The type of object - article_translated_content. Allowed: `null`, `article_translated_content`.
`result.data.data[].translated_content.ar`	`object \| null`	No	—	The Content of an Article.
`result.data.data[].translated_content.ar.type`	`null \| "article_content"`	No	—	The type of object - `article_content` . Allowed: `null`, `article_content`.
`result.data.data[].translated_content.ar.title`	`string`	No	—	The title of the article.
`result.data.data[].translated_content.ar.description`	`string`	No	—	The description of the article.
`result.data.data[].translated_content.ar.body`	`string`	No	—	The body of the article.
`result.data.data[].translated_content.ar.author_id`	`integer`	No	—	The ID of the author of the article.
`result.data.data[].translated_content.ar.state`	`"published" \| "draft"`	No	—	Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`.
`result.data.data[].translated_content.ar.created_at`	`integer`	No	—	The time when the article was created (seconds). Format: `date-time`.
`result.data.data[].translated_content.ar.updated_at`	`integer`	No	—	The time when the article was last updated (seconds). Format: `date-time`.
`result.data.data[].translated_content.ar.url`	`string`	No	—	The URL of the article.
`result.data.data[].translated_content.bg`	`object \| null`	No	—	The Content of an Article.
`result.data.data[].translated_content.bg.type`	`null \| "article_content"`	No	—	The type of object - `article_content` . Allowed: `null`, `article_content`.
`result.data.data[].translated_content.bg.title`	`string`	No	—	The title of the article.
`result.data.data[].translated_content.bg.description`	`string`	No	—	The description of the article.
`result.data.data[].translated_content.bg.body`	`string`	No	—	The body of the article.
`result.data.data[].translated_content.bg.author_id`	`integer`	No	—	The ID of the author of the article.
`result.data.data[].translated_content.bg.state`	`"published" \| "draft"`	No	—	Whether the article is `published` or is a `draft` . Allowed: `published`, `draft`.
`result.data.data[].translated_content.bg.created_at`	`integer`	No	—	The time when the article was created (seconds). Format: `date-time`.
`result.data.data[].translated_content.bg.updated_at`	`integer`	No	—	The time when the article was last updated (seconds). Format: `date-time`.
`result.data.data[].translated_content.bg.url`	`string`	No	—	The URL of the article.
`result.data.data[].translated_content.bs`	`object \| null`	No	—	The Content of an Article.

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_articles --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