List Revisions
- REST Method: GET
- URL: https://docsapi.helpscout.net/v1/articles/{id}/revisions
Note: This endpoint returns an array of ArticleRevisionRef objects, which do not contain the text attribute associated with an ArticleRevision object and is more suitable for displaying in a list.
Request
Name | Type | Required | Default | Options | Notes |
---|---|---|---|---|---|
page | Int | No | 1 |
To request subsequent pages:
- https://docsapi.helpscout.net/v1/articles/{id}/revisions?page=2
Response
Response | Name | Type | Notes |
---|---|---|---|
Header | Status | Int | 200 |
Body | page | Int | Current page that was passed in on the request |
pages | Int | Total number of pages available | |
count | Int | Total number of objects available | |
items | Collection | Collection of ArticleRevisionRef objects. |
{
"revisions": {
"page": 1,
"pages": 1,
"count": 4,
"items": [
{
"id": "5230deaa456636123f6363d0",
"articleId": "522f918d1ef00a6bca026ca0",
"createdBy": {
"id": 73423,
"firstName": "John",
"lastName": "Appleseed"
},
"createdAt": "2013-09-11T21:20:42Z"
},
{... article revision object ...},
{... article revision object ...},
{... article revision object ...}
]
}
}