GET
/articles/{id}/draftRetrieve an article draft
Retrieves the staged draft of a published article without changing its live content. Use the id path parameter to identify the article; a draft exists only when unpublished changes have been staged. You need the read_articles_scope OAuth scope to retrieve the draft.
idintegerrequired
The unique integer identifier for the article whose staged draft you want to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
200Returns the article object rendered with its staged draft content; the live article remains unchanged.
statisticsobjectoptional
The statistics of an article.
typestringoptional
The type of object - `article`.
idstringoptional
The unique identifier for the article which is given by Intercom.
workspace_idstringoptional
The id of the workspace which the article belongs to.
titlestringoptional
The title of the article. For multilingual articles, this will be the title of the default language's content.
descriptionstringoptional
The description of the article. For multilingual articles, this will be the description of the default language's content.
bodystringoptional
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
body_markdownstringoptional
The body of the article in markdown. For multilingual articles, this will be the body of the default language's content.
author_idintegeroptional
The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.
statestringoptional
Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.
created_atintegeroptional
The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.
updated_atintegeroptional
The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.
has_unpublished_changesbooleanoptional
Whether the published article has unpublished changes staged as a draft on top of its live content. For multilingual articles this reflects the default language's content; a pure draft (never published) reports `false`.
draft_updated_atintegeroptional
The time, in seconds, when the staged draft was last edited, or `null` when there is no staged draft.
urlstringoptional
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
parent_idsarray<integer>optional
The ids of the article's parent collections or sections. An article without this field stands alone.
ai_chatbot_availabilitybooleanoptional
Whether the article is available for AI Chatbot. For multilingual articles, this will be the value of the default language's content.
ai_copilot_availabilitybooleanoptional
Whether the article is available for AI Copilot. For multilingual articles, this will be the value of the default language's content.
ai_sales_agent_availabilitybooleanoptional
Whether the article is available for AI Sales Agent. For multilingual articles, this will be the value of the default language's content.
created_by_idintegeroptional
The ID of the teammate who created the article. For multilingual articles, this will be the creator of the default language's content.
updated_by_idintegeroptional
The ID of the teammate who last updated the article. For multilingual articles, this will be the last editor of the default language's content.
exclude_from_article_suggestionsbooleanoptional
Whether the article is excluded from Fin AI Agent article suggestions.
help_center_audiencestringoptional
The audience that can view this article in the Help Center. `everyone` means all users and visitors can view it; `restricted` indicates a custom audience ruleset. For multilingual articles, this is the article-level audience.
scheduled_publish_atintegeroptional
The Unix timestamp (in seconds) at which the article is scheduled to be published. `null` when no publish is scheduled. Mutually exclusive with `scheduled_unpublish_at` — at most one pending schedule exists per article.
scheduled_unpublish_atintegeroptional
The Unix timestamp (in seconds) at which the article is scheduled to be unpublished. `null` when no unpublish is scheduled. Mutually exclusive with `scheduled_publish_at` — at most one pending schedule exists per article.
default_localestringoptional
The default locale of the help center. This field is only returned for multilingual help centers.
translated_contentobjectoptional
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
tagsobjectoptional
A list of tags objects associated with a conversation
folder_idintegeroptional
The ID of the folder this article belongs to, or null if not in a folder.
401Returned when the request is unauthorized or lacks the required OAuth scope.
One documented failure
unauthorizedAccess Token Invalid
typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the article does not exist or has no staged draft.
2 documented failures
not_foundObject not found
data_invalidIntegration not found
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 unauthorized or lacks the read_articles_scope OAuth scope. A 404 is returned when the id path parameter does not identify an article with a staged draft.