API Documentation

The REST API allows developers to hook into Clientexec and connect it to third-party applications.

Get KB Articles

Arguments

Name Type Description
limit int number of tickets replies - defaults to 5
tag string return list of articles that have been tagged with this string (does not work with other params)
catid string return list of articles based on category id (does not work with other params)

Example JSON Response

{
    "timestamp": 1391210935,
    "count": 5,
    "articles": [
        {
            "id": "377",
            "name": "How do I use coupons? ",
            "excerpt": "To add coupons, you can navigate to Setup - Settings - Billing - Coupons and configure the...",
            "created": "2014-01-30 18:02:26",
            "visitors": "1",
            "categoryid": "6",
            "rating": 0
        },
        {
            "id": "376",
            "name": "How do I remove the register link?",
            "excerpt": "If you want to remove the Register link from the public portal, open...",
            "created": "2014-01-30 17:40:38",
            "visitors": "2",
            "categoryid": "6",
            "rating": 0
        },
        {
            "id": "366",
            "name": "Setting up chat for guests",
            "excerpt": "The first thing you'll need to do is add the code to your website. <span...",
            "created": "2014-01-09 19:31:03",
            "visitors": "35",
            "categoryid": "6",
            "rating": 5
        },
        {
            "id": "363",
            "name": "Using the sidebar",
            "excerpt": "When you first login to ClientExec, you will notice that the sidebar hasn't been configured...",
            "created": "2014-01-09 18:40:06",
            "visitors": "24",
            "categoryid": "6",
            "rating": 0
        },
        {
            "id": "374",
            "name": "How do I choose which filter number displays in the nav bar?",
            "excerpt": "To choose which filter number is displaying in the nav bar (Next to Support) you will need to...",
            "created": "2014-01-16 18:01:54",
            "visitors": "17",
            "categoryid": "6",
            "rating": 5
        }
    ],
    "elapsed": "0.565",
    "message": ""
}