List article versions

Request

Fetch the version history of an article by making a GET request to https://api.intercom.io/articles/<article_id>/versions. Versions are returned newest-first as a paginated list of metadata. Use GET /articles/{article_id}/versions/{id} to retrieve a single version with its full content.

Requires the read_articles_scope OAuth scope. Set Intercom-Version: Preview.

Security

bearerAuth

Path

article_idintegerrequired

The unique identifier for the article whose versions you are listing.

Example:123

Query

pageinteger

The page of results to fetch. Defaults to the first page.

Example:page=1

per_pageinteger

The number of results to return per page.

Example:per_page=25

localestring

Filter versions to a specific locale. Use the locale identifier (for example en, fr). If the locale is not configured for the workspace, a 400 is returned.

Example:locale=en

Headers

Intercom-Versionstring(intercom_version)

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

Default:"Preview"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X GET \
  'https://api.intercom.io/articles/123/versions?page=1&per_page=25&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Versions found

Bodyapplication/json

typestring

The type of the object - list.

Value:"list"

Example:"list"

pagesobject or null(Cursor based pages)

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_countinteger

A count of the total number of versions.

Example:2

dataArray of objects(Article Version Summary)

An array of Article version summary objects.

Response

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "per_page": 25,
    "total_pages": 1
  },
  "total_count": 2,
  "data": [
    { … },
    { … }
  ]
}