Home
/
REST API Reference
/
AI Content
/
Retrieve an external page

Retrieve an external page

You can retrieve an external page.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
string

The unique identifier for the external page which is given by Intercom.

header Parameters
Intercom-Version
string (intercom_version)
Default: Unstable

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: Unstable
get
/ai/external_pages/{id}
Request samples
Responses
200
successful
Response Schema: application/json
type
required
string 
 Default: "external_page"
Always external_page
 Value: "external_page"  
id
required
string 
The unique identifier for the external page which is given by Intercom.
 
title
required
string 
The title of the external page.
 
html
required
string 
The body of the external page in HTML.
 
url
required
string 
The URL of the external page. This will be used by Fin to link end users to the page it based its answer on.
 
ai_agent_availability
required
boolean 
Whether the external page should be used to answer questions by AI Agent.
 
ai_copilot_availability
required
boolean 
Whether the external page should be used to answer questions by AI Copilot.
 
fin_availability
boolean 
Deprecated. Use ai_agent_availability and ai_copilot_availability instead.
 
locale
required
string 
 Default: "en"
Always en
 Value: "en"  
source_id
required
integer 
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.
 
external_id
string 
The identifier for the external page which was given by the source. Must be unique for the source.
 
created_at
required
integer <date-time>  
The time when the external page was created.
 
updated_at
required
integer <date-time>  
The time when the external page was last updated.
 
last_ingested_at
required
integer <date-time>  
The time when the external page was last ingested.
 
401
Unauthorized
Response samples
application/json
{
"id": "7",
"type": "external_page",
"title": "My External Content",
"html": "<h1>Hello world</h1><p>This is external content</p>",
"url": "https://support.example.com/us/6",
"ai_agent_availability": true,
"ai_copilot_availability": true,
"fin_availability": true,
"locale": "en",
"source_id": 14,
"external_id": "5",
"created_at": 1715701763,
"updated_at": 1715701763,
"last_ingested_at": 1715701763
}