KB Articles Endpoint

Obtain a list of knowledge base articles for your account.

GET //developer.livehelpnow.net/api/kb/articles

Query Params

Name Expected Type Description
start_index optional integer Set start index for result set
count optional integer Set count/limit per page for result set

Result

{
 "status": "ok",
 "payload": {
  "entries": [
   {
    "answer": "The article answer",
    "article_id": 12345,
    "categories": [
     "category"
    ],
    "client_id": 12345,
    "link": "http://yourkb.com/link/to/article/",
    "order": 1,
    "question": "The article question",
    "rating": 4.5,
    "tags": [
     "tag"
    ],
    "title": "The article title",
    "url_title": "the-article-title",
    "view_count": 12345,
    "vote_count": 12345,
    "vote_total": 12345
   },
   ...
  ],
  "total_rows": 10,
  "count": 10,
  "start_index": 1
 }
}

entries array The list of visitors
 answer string The answer of the atricle
 article_id integer A unique identifier for the visitor
 categories array A list of category names associated to the article
 client_id integer A unique identifier for the client
 link string The link of the atricle
 order integer The article order position
 question string The question of the atricle
 rating float The average rating of the article
 tags array A list of tag names associated to the article
 title string The title of the atricle
 url_title string The SEO friendly title of the atricle
 view_count integer The total number of views for the article
 vote_count integer The total number of votes submitted for the article
 vote_total integer The sum of all votes for the article