Fill in the fields below, then reference the result from later steps as {{listArticles.response.data}}.
Request
Headers
Intercom-Versionstring
Intercom API version.</br>By default, it's equal to the version set in the app package.
One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"
Response
Returns 200 with an object. Read it in later steps with {{listArticles.response.data.<field>}}.
typestring
The type of the object - `list`.
One oflist
pagesobject
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.
typestring
the type of object `pages`.
One ofpages
pageinteger
The current page
nextobject2 fields
per_pageinteger
Number of results per page
total_pagesinteger
Total number of pages
total_countinteger
A count of the total number of articles.
dataarray<object>
An array of Article objects
typestring
The type of object - `article`.
One ofarticleDefault "article"
idstring
The unique identifier for the article which is given by Intercom.
workspace_idstring
The id of the workspace which the article belongs to.
titlestring
The title of the article. For multilingual articles, this will be the title of the default language's content.
descriptionstring
The description of the article. For multilingual articles, this will be the description of the default language's content.
bodystring
The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.
body_markdownstring
The body of the article in markdown. For multilingual articles, this will be the body of the default language's content.
author_idinteger
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.
statestring
Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.
One ofpublisheddraftDefault "draft"
created_atinteger (date-time)
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_atinteger (date-time)
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_changesboolean
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_atinteger (date-time)
The time, in seconds, when the staged draft was last edited, or `null` when there is no staged draft.
urlstring
The URL of the article. For multilingual articles, this will be the URL of the default language's content.
parent_idsarray<integer>
The ids of the article's parent collections or sections. An article without this field stands alone.
ai_chatbot_availabilityboolean
Whether the article is available for AI Chatbot. For multilingual articles, this will be the value of the default language's content.
ai_copilot_availabilityboolean
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_availabilityboolean
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_idinteger
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_idinteger
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_suggestionsboolean
Whether the article is excluded from Fin AI Agent article suggestions.
help_center_audiencestring
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.
One ofeveryoneall_usersall_visitorsall_leadsall_visitors_and_leadsrestricted
scheduled_publish_atinteger (date-time)
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_atinteger (date-time)
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_localestring
The default locale of the help center. This field is only returned for multilingual help centers.
translated_contentobject38 fields
The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.
tagsobject2 fields
A list of tags objects associated with a conversation
json
{"type":"list","pages":{"type":"pages","page":1,"next":{"per_page":2,"starting_after":"your-cursor-from-response"},"per_page":2,"total_pages":13},"total_count":1,"data":[{"type":"article","id":"6871119","workspace_id":"hfi1bx4l","title":"Default language title","description":"Default language description","body":"Default language body in html","body_markdown":"# Default language title\n\nDefault language body in markdown\n","author_id":"5017691","state":"published","created_at":1672928359,"updated_at":1672928610,"has_unpublished_changes":false}]}
Need more? See the Intercom guide for connection setup and behaviour shared by every action.
