Intercom: List External Pages

List the external pages in the Intercom Fin content library.

Tool ID: intercom_list_external_pages

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

console.log(result.toolResponse.raw);

CLI

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

Example response

The static output schema lacks the details for a reliable example. Use deepline describe intercom_list_external_pages --json for the complete live contract.

Input reference

You can retrieve a list of all external pages for a workspace. 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 external pages for the App.
`result.data.type`	`"list"`	No	—	The type of the object - `list`. Allowed: `list`.
`result.data.pages`	`object`	No	—	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.
`result.data.pages.type`	`"pages"`	No	—	Allowed: `pages`.
`result.data.pages.page`	`integer`	No	—	—
`result.data.pages.next`	`string \| null`	No	—	A link to the next page of results. A response that does not contain a next link does not have further data to fetch. Format: `uri`.
`result.data.pages.per_page`	`integer`	No	—	—
`result.data.pages.total_pages`	`integer`	No	—	—
`result.data.total_count`	`integer`	No	—	A count of the total number of external pages.
`result.data.data`	`array`	No	—	An array of External Page objects
`result.data.data[].type`	`"external_page"`	Yes	`"external_page"`	Always external_page Allowed: `external_page`.
`result.data.data[].id`	`string`	Yes	—	The unique identifier for the external page which is given by Intercom.
`result.data.data[].title`	`string`	Yes	—	The title of the external page.
`result.data.data[].html`	`string`	Yes	—	The body of the external page in HTML.
`result.data.data[].url`	`string`	No	—	The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.
`result.data.data[].ai_agent_availability`	`boolean`	Yes	—	Whether the external page should be used to answer questions by AI Agent.
`result.data.data[].ai_copilot_availability`	`boolean`	Yes	—	Whether the external page should be used to answer questions by AI Copilot.
`result.data.data[].ai_sales_agent_availability`	`boolean`	No	—	Whether the external page should be used to answer questions by AI Sales Agent.
`result.data.data[].fin_availability`	`boolean`	No	—	Deprecated. Use ai_agent_availability and ai_copilot_availability instead.
`result.data.data[].locale`	`"en"`	Yes	`"en"`	Always en Allowed: `en`.
`result.data.data[].source_id`	`integer`	Yes	—	The unique identifier for the source of the external page which was given by Intercom. Every external page must be associated with a Content Import Source which represents the place it comes from and from which it inherits a default audience (configured in the UI). For a new source, make a POST request to the Content Import Source endpoint and an ID for the source will be returned in the response.
`result.data.data[].external_id`	`string`	Yes	—	The identifier for the external page which was given by the source. Must be unique for the source.
`result.data.data[].created_at`	`integer`	Yes	—	The time when the external page was created. Format: `date-time`.
`result.data.data[].updated_at`	`integer`	Yes	—	The time when the external page was last updated. Format: `date-time`.
`result.data.data[].last_ingested_at`	`integer`	Yes	—	The time when the external page was last ingested. Format: `date-time`.
`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