API: Rest Get All Articles

The Get Articles commands allow you to return the content of all articles in the realm. This command returns the article ID, name, description, author email, author name, title, author bio, deck, callout, and body of each article.

GET /articles

https://[siteurl]/rest/articles

Request Body Parameters

The Get Articles command requires only the URI call. No additional fields are required in the JSON.

Request Body Example

Using Get Articles:

curl --request GET \
--url 'https://mail.mydomain.com/rest/articles' \
--header 'authorization: Basic bXlBY2NvdW50Onh5enB3ZDEyMw==' \
--header 'accept: application/vnd.whatcounts-v1+json' \
--header 'content-type: application/json' \
--include

Response Body

SUCCESS

The Get Template commands do not explicitly return a Success code. Instead, it outputs the template data. Use the Output Format argument to return the results in a specific format.

JSON

{
    "skip": 0,
    "max": 0,
    "articleId": 1234,
    "realmId": 1234,
    "name": "Name",
    "description": "Description",
    "authorEmail": "",
    "authorName": "",
    "title": "Title",
    "createdDate": "Dec 05, 2022 17:01:43 PM",
    "updatedDate": "Dec 05, 2022 17:01:43 PM",
    "folderId": 0,
    "authorBio": "",
    "dek": "",
    "callout": "",
    "body": "Body",
    "dataXml": "",
    "parentArticleId": 0,
    "saveMode": "text",
    "dto": {
        "skip": 0,
        "max": 0,
        "articleId": 1234,
        "realmId": 1234,
        "name": "Name",
        "description": "Description",
        "authorEmail": "",
        "authorName": "",
        "title": "Title",
        "createdDate": "Dec 05, 2022 17:01:43 PM",
        "updatedDate": "Dec 05, 2022 17:01:43 PM",
        "folderId": 0,
        "authorBio": "",
        "dek": "",
        "callout": "",
        "body": "Body",
        "dataXml": "",
        "parentArticleId": 0,
        "childCount": 0
    }
}

FAILURE

A Get Template command will fail for several reasons.