Example Request & Response (Single Language Help Center)
$ curl https://api.intercom.io/articles \
-X GET \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
-H 'Content-Type: application/json' -d
HTTP/1.1 200 OK
{
"type": "list",
"pages": {
"type": "pages",
"page": 1,
"per_page": 20,
"total_pages": 1
},
"total_count": 2,
"data": [
{
"id": 1,
"type": "article",
"workspace_id": "abcdef",
"title": "Default language title",
"description": "Default language description",
"body": "Default language body in html",
"author_id": 1,
"state": "published",
"created_at": 123456,
"updated_at": 123456,
"url": "http://intercom.help/en/articles/1-art",
"parent_id": 1,
"parent_type": "collection"
},
{
"id": 2,
"type": "article",
"workspace_id": "abcdef",
"title": "Default language title 2",
"description": "Default language description 2",
"body": "Default language body in html 2",
"author_id": 1,
"state": "draft",
"created_at": 789456,
"updated_at": 789456,
"url": "http://intercom.help/en/articles/2-art",
"parent_id": 1,
"parent_type": "collection"
}
]
}
You can fetch a list of all articles by making a GET request to https://api.intercom.io/articles
.
Response
Key | Type | Description |
---|---|---|
type | String | The type of object - list . |
pages | Object | A Pages object with the information needed to paginate through Articles. |
total_count | Integer | A count of the total number of articles. |
data | Array | An array of Article Objects. |
How are the articles sorted and ordered?
Articles will be returned in descending order on the
updated_at
attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.