GET/internal_articles

List internal articles

Lists internal articles available to the authenticated user. Use the pages metadata to navigate the cursor-based results and total_count to see the number of articles.

1 parameter
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a list of internal articles with cursor-based pagination metadata and the total article count.
typestringoptional
The type of the object - `list`.
Allowed:list
pagesobjectoptional
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.
total_countintegeroptional
A count of the total number of internal articles.
dataarray<InternalArticles>optional
An array of Internal Article objects
401Returned when the request is not authorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is not authorized. The Intercom-Version header selects the API version and defaults to 2.17 when omitted.