The intercom API reference.
https://api.intercom.io/
https://api.eu.intercom.io/
https://api.au.intercom.io/
With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
Â
External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
Â
Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
Â
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
The data returned about your internal articles when you list them.
The type of object - internal_article.
{ "type": "internal_article", "id": "6871119", "title": "string", "body": "Default language body in html", "owner_id": "5017691", "author_id": "5017691", "created_at": 1672928359, "updated_at": 1672928610, "locale": "en" }
The results of an Internal Article search
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.
{ "type": "list", "total_count": 5, "data": { "internal_articles": [ … ] }, "pages": { "type": "pages", "page": 1, "next": { … }, "per_page": 2, "total_pages": 13 } }
https://api.intercom.io/internal_articles
https://api.eu.intercom.io/internal_articles
https://api.au.intercom.io/internal_articles
curl -i -X GET \
https://api.intercom.io/internal_articles \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: Unstable'{ "type": "list", "pages": { "type": "pages", "page": 1, "per_page": 25, "total_pages": 1 }, "total_count": 1, "data": [ { … } ] }
https://api.intercom.io/internal_articles
https://api.eu.intercom.io/internal_articles
https://api.au.intercom.io/internal_articles
curl -i -X POST \
https://api.intercom.io/internal_articles \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: Unstable' \
-d '{
"title": "Thanks for everything",
"body": "Body of the Article",
"owner_id": 991266252,
"author_id": 991266252,
"locale": "en"
}'{ "id": "42", "title": "Thanks for everything", "body": "Body of the Article", "owner_id": 991266252, "author_id": 991266252, "locale": "en" }
https://api.intercom.io/internal_articles/{id}
https://api.eu.intercom.io/internal_articles/{id}
https://api.au.intercom.io/internal_articles/{id}
curl -i -X GET \
https://api.intercom.io/internal_articles/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: Unstable'{ "id": "45", "body": "Body of the Article", "owner_id": 991266252, "author_id": 991266252, "locale": "en" }
https://api.intercom.io/internal_articles/{id}
https://api.eu.intercom.io/internal_articles/{id}
https://api.au.intercom.io/internal_articles/{id}
curl -i -X PUT \
https://api.intercom.io/internal_articles/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: Unstable' \
-d '{
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>"
}'{ "id": "48", "body": "Body of the Article", "owner_id": 991266252, "author_id": 991266252, "locale": "en" }
https://api.intercom.io/internal_articles/{id}
https://api.eu.intercom.io/internal_articles/{id}
https://api.au.intercom.io/internal_articles/{id}
curl -i -X DELETE \
https://api.intercom.io/internal_articles/123 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: Unstable'{ "id": "51", "object": "internal_article", "deleted": true }
https://api.intercom.io/internal_articles/search
https://api.eu.intercom.io/internal_articles/search
https://api.au.intercom.io/internal_articles/search
curl -i -X GET \
'https://api.intercom.io/internal_articles/search?folder_id=123' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: Unstable'Search successful
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.
{ "type": "list", "total_count": 1, "data": { "internal_articles": [ … ] }, "pages": { "type": "pages", "page": 1, "total_pages": 1, "per_page": 10 } }
With the closed beta "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.
Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.
Note: If you are interested in joining our closed beta and have a use case to integrate with "Fin over API", please reach out to your account manager or our support team for further information.
Everything about your Custom Object instances.
From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.