Intercom: Retrieve Internal Article

Get an Intercom internal article by its ID.

Tool ID: intercom_retrieve_internal_article

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_retrieve_internal_article',
  {
    "internal_article_id": 123
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_retrieve_internal_article --input '{
  "internal_article_id": 123
}' --json

Example response

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

{
  "data": {
    "type": "internal_article",
    "id": "id_123",
    "title": "VP of Engineering"
  }
}

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

Input reference

You can fetch the details of a single internal article by making a GET request to https://api.intercom.io/internal_articles/ .

Name	Type	Required	Default	Details
`payload.internal_article_id`	`integer`	Yes	—	The unique identifier for the article which is given by Intercom.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	The data returned about your internal articles when you list them.
`result.data.type`	`"internal_article"`	No	`"internal_article"`	The type of object - `internal_article`. Allowed: `internal_article`.
`result.data.id`	`string`	No	—	The unique identifier for the article which is given by Intercom.
`result.data.title`	`string`	No	—	The title of the article.
`result.data.body`	`string \| null`	No	—	The body of the article in HTML.
`result.data.owner_id`	`integer`	No	—	The id of the owner of the article.
`result.data.author_id`	`integer`	No	—	The id of the author of the article.
`result.data.created_at`	`integer`	No	—	The time when the article was created. Format: `date-time`.
`result.data.updated_at`	`integer`	No	—	The time when the article was last updated. Format: `date-time`.
`result.data.locale`	`string`	No	—	The default locale of the article.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

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