GET/articles/{article_id}/versions

List article versions

Lists an article's version history as paginated metadata, with the newest versions first. Use locale to filter the history to a configured locale, and use page and per_page to paginate the results. Retrieve an individual version to access its full content.

5 parameters
article_idintegerrequired
The unique integer identifier for the article whose versions to list.
pageintegeroptional
The page of results to retrieve. Defaults to the first page when omitted.
per_pageintegeroptional
The number of version results to return per page.
localestringoptional
A configured locale identifier, such as `en` or `fr`, to filter the version history.
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

4 status codes
200Returns a paginated list of article version metadata, including each version's title, author, state, and creation time. The summaries omit version body content.
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 versions.
dataarray<ArticleVersionSummary>optional
An array of Article version summary objects.
400Returned when `locale` is not configured for the workspace.

One documented failure

  • parameter_invalid

    Unknown locale

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

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
404Returned when no article exists with the given `article_id`.

2 documented failures

  • not_found

    Object not found

  • data_invalid

    Integration not found

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

Error handling

A 400 is returned when locale is not configured for the workspace. A 401 is returned when the request is unauthorized. A 404 is returned when the article_id path parameter does not identify an article.