GET/articles/{article_id}/versions/{id}

Retrieve an article version

Retrieves a historical version of an article, including its title, description, and body content. Use article_id and id to identify the article and version, and locale to request content for a specific locale. Access requires the read_articles_scope OAuth scope.

4 parameters
article_idintegerrequired
The unique identifier of the article that contains the version.
idstringrequired
The unique identifier of the article version to retrieve.
localestringoptional
The locale for the version content. The locale must be configured for the workspace.
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 the article version object, including its title, description, HTML and Markdown body, author and creator identifiers, state, and timestamps.
typestringoptional
String representing the object's type. Always has the value `article_version`.
Allowed:article_version
idstringoptional
The unique identifier for the version.
article_idstringoptional
The unique identifier of the article this version belongs to.
titlestringoptional
The title of the article at this version.
descriptionstringoptional
The description of the article at this version.
bodystringoptional
The HTML body of the article at this version.
body_markdownstringoptional
The Markdown body of the article at this version.
author_idstringoptional
The id of the teammate listed as the article's author at this version.
created_by_idstringoptional
The id of the teammate who created this version.
created_viastringoptional
How this version was created (for example `web`, `api`).
from_version_idstringoptional
The id of the version this version was created from, or `null` if this is the first version.
statestringoptional
Whether this version is the currently published version of the article (`published`) or an earlier non-live version (`draft`).
Allowed:publisheddraft
created_atintegeroptional
The time the version was created, as a UTC Unix timestamp.
updated_atintegeroptional
The time the version was last updated, as a UTC Unix timestamp.
400Returned when the requested 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 the requested article or version is not found.

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, and a 404 is returned when the article or version cannot be found. The article_id path parameter and id path parameter must identify the article and version; access requires the read_articles_scope OAuth scope.