List Knowledge Base Articles

GET/api/knowledge-base/articles

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
type String optional Optional area filter, knowledge_base or help. Defaults to knowledge_base
include_internal Boolean optional Optional, set to 1 to include the internal help area. Defaults to 0
status String optional Optional article status, active or inactive. Only honoured when include_internal is 1
category_id Number optional Optional filter by help category ID
label_id Number optional Optional filter by label ID
curl -X GET "https://yoursite.com/api/knowledge-base/articles" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "12",
    "title": "How to reset a password",
    "category_id": "3",
    "category_title": "Getting started",
    "type": "knowledge_base",
    "status": "active",
    "total_views": "41",
    "sort": "0"
  }
]
MethodGET
Path/api/knowledge-base/articles
GroupKnowledge Base
Sincev1.0.0
Defined inRestApi/Controllers/KnowledgeBaseController.php