Skip to main content

Get the List of Articles

Description

You can use this API to get the list of all the available articles.

Query Parameters (Optional)

  • limit : To specify the no. of articles to fetch where the default value is 10 and you can increase the limit to a maximum of 99.
  • page : To specify the page number. The value starts from 1 (default), you can increase the column number as you wish to fetch the articles.
  • sort_by : To sort the articles based on views/likes/dislikes/used.
  • order : You can use ascending or descending to sort the articles order.
  • department_id : To get the list of articles under the department ID
  • category_id : To get the list of articles under a particular category
  • mode : To get the articles based on the mode (publish/draft)

OAuth Scope:

SalesIQ.articles.READ

URL

Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screenname}/articles

Example:

Copiedhttps://salesiq.zoho.com/api/v2/zylker-inc/articles

Success Response

Copied{
  "url": "/api/v2/zylker-inc/articles",
  "object": "list",
  "data": [
    {
      "modified_time": "1569827116182",
      "category": {
        "name": "Zylker - Promo",
        "id": "17000000012001"
      },
      "id": "17000000012007",
      "modifier": {
        "name": "Patricia",
        "id": "17000000007001"
      },
      "creator": {
        "name": "Patricia",
        "id": "17000000007001"
      },
      "stats": {
        "viewed": "10",
        "used": "2",
        "liked": "4",
        "disliked": "1"
      },
      "enabled": true,
      "published": true,
      "department_id": "17000000002003",
      "title": "Applying Promo/coupon code",
      "created_time": "1569827116182"
    },
    {
      "modified_time": "1569826933765",
      "category": {
        "name": "Zylker - Coupon",
        "id": "17000000012001"
      },
      "id": "17000000012005",
      "modifier": {
        "name": "Tricia",
        "id": "17000000007001"
      },
      "creator": {
        "name": "Tricia",
        "id": "17000000007001"
      },
      "stats": {
        "viewed": "20",
        "used": "12",
        "liked": "13",
        "disliked": "3"
      },
      "enabled": true,
      "published": true,
      "department_id": "17000000002003",
      "title": "Renew Coupon Codes",
      "created_time": "1569826933765"
    }
  ],
  "sync_time": "1569837898945"
}