Get Articles

This endpoint allows you to get all the existing articles in Knowledge Base.

Get All Articles

GET https://{{account_id}}.acquire.io/api/v1/kb/article?groupId={{groupId}}

This endpoint allows you to get all the existing articles in Knowledge Base.

Query Parameters

Name	Type	Description
groupId	integer	The Knowledge Base group ID
page	integer	Limit the number of pages you receive if you are using pagination.
limit	number	Limit the number of articles you receive.
search	string	Search for article keywords.
categoryId	integer	Retrieve articles from a category with its categoryId.
ids	array	Array of integers. Retrieve articles by their Ids. Example: [1, 2, 3]
author	integer	Retrieve articles written by an author with the author's ID. Example: 1
access	string	Indicate article permissions: [internal, protected, active]
status	string	Indicate draft status: [draft, active, archive]

Headers

Name	Type	Description
Authorization	string	Bearer {{API_key}}

200

{
  "data": {
    "articleCount": 1,
    "limit": 1,
    "page": 1,
    "articles": [
      {
        "id": 1646,
        "title": "new",
        "description": "",
        "articleSlug": "new",
        "featuresImage": null,
        "category": [],
        "author": {
          "users": {
            "1": {
              "departments": [],
              "roles": [
                {
                  "id": 1,
                  "roleName": "Administrator"
                }
              ],
              "id": 1,
              "name": "gdfgfd",
              "firstName": "gdfgfd",
              "lastName": "",
              "photo": "https://local-dev-drive.acquire.io/vrsx1t/media/2020/12/profile-9f6d2ac37a873b12756e057c.jpeg",
              "email": "[e-mail]",
              "type": "user",
              "accessLevel": null
            }
          }
        },
        "updatedBy": {
          "users": {
            "1": {
              "departments": [],
              "roles": [
                {
                  "id": 1,
                  "roleName": "Administrator"
                }
              ],
              "id": 1,
              "name": "gdfgfd",
              "firstName": "gdfgfd",
              "lastName": "",
              "photo": "https://local-dev-drive.acquire.io/vrsx1t/media/2020/12/profile-9f6d2ac37a873b12756e057c.jpeg",
              "email": "[e-mail]",
              "type": "user",
              "accessLevel": null
            }
          }
        },
        "createdBy": {
          "users": {
            "1": {
              "departments": [],
              "roles": [
                {
                  "id": 1,
                  "roleName": "Administrator"
                }
              ],
              "id": 1,
              "name": "gdfgfd",
              "firstName": "gdfgfd",
              "lastName": "",
              "photo": "https://local-dev-drive.acquire.io/vrsx1t/media/2020/12/profile-9f6d2ac37a873b12756e057c.jpeg",
              "email": "[e-mail]",
              "type": "user",
              "accessLevel": null
            }
          }
        },
        "dateCreated": "2021-03-22T05:54:37.000Z",
        "dateUpdated": "2021-03-22T05:54:37.000Z",
        "botAssigned": "no",
        "autoRelated": "yes",
        "access": "active",
        "status": "archive"
      }
    ]
  }
}