API Documentation

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

Get Ticket

Example JSON Response

{
    "timestamp": 1391210906,
    "metadata": {
        "id": "1000",
        "userStatus": "1",
        "userEmail": "[email protected]",
        "isGuest": false,
        "userGroupColor": "",
        "submittedBy": "Joshua Post",
        "priority": "2",
        "domainid": "0",
        "userPackageReference": "Not applicable",
        "planname": "Not applicable",
        "serverName": "",
        "flag": "clear",
        "dateSubmitted": 1048894966,
        "dateSubmittedFormatted": "2003-03-28 17:42:46",
        "statusName": "Closed",
        "status": "-1",
        "userid": "112",
        "assignedToId": "0",
        "assignedToDeptId": "1",
        "assignedToFull": "General",
        "assignedToName": "General",
        "subscribe_title": "Subscribe",
        "subscribe_id": 0,
        "ticket_priority": "2",
        "ticket_status_name": "Closed",
        "ticket_status": "-1",
        "ticket_type": "1",
        "ticket_type_name": "Software Issue",
        "subject": "Domain Options\/Templates\/API",
        "time_elapsed": "2 hrs  38 mins",
        "time_elapsed_in_minutes": 5705265,
        "show_delete_action": true,
        "show_spam_action": false,
        "show_notification_action": false,
        "show_close_action": true,
        "show_reply_action": false,
        "file_upload_size": "25M",
        "file_upload_ext": "",
        "show_attachments": true,
        "ticket-action-attach": true,
        "allowed_ext": "*",
        "attachments": [

        ]
    },
    "comments": [
        {
            "logid": 1,
            "authorName": "Joshua Post",
            "authorEmail": "[email protected]",
            "isAdmin": false,
            "authorId": "112",
            "action": "0",
            "createdAt": "03\/28\/2003 05:42:46 pm",
            "avatar_url": "http://somelonghashedurl.com",
            "message": "Hi,\r\n\r\nFirstly, I'd like to congratulate you on a superbly crafted application, I am very pleased with my purchase indeed.  I realise that this release\/product is still pretty fresh from the code mines but perhaps you could answer some queries for me.  \r\n\r\n1. With the domains option enabled in signup, how do we tell whether a customer wishes us to register a domain for them and how do we set pricing for them?\r\n\r\n2. I can't seem to find a way to store our address to be used in PDF Invoices etc.  Is there a way other than the extra field option?\r\n\r\n3. Templates, this looks fairly straightforward but is there any documentation as to variables we can use in them?\r\n\r\n4. API  I guess this is mainly for payment gateways or will it be wider than that?\r\n\r\nOnce, again - Good Job!\r\n\r\nThanks and regards,\r\n\r\nDamon",
            "isExternalEmail": true,
            "attachments": [

            ]
        },
        {
            "logid": 3,
            "authorName": "Tech Support",
            "authorId": 0,
            "isAdmin": false,
            "authorEmail": "",
            "action": "0",
            "createdAt": "03\/28\/2003 08:21:01 pm",
            "avatar_url": "http://somelonghashedurl.com",
            "message": "1 - If you look in the road map in announcements this is really part of the TLD module we are adding.  You will notice in the signup email though that you are told if they want you to register the domain for them or not.  If would require you to manually invoice them for that charge at the moment though.\r\n\r\n2 - You can store that in settings->invoices extra invoice settings\r\n\r\n3 - Not at the moment, but it is straight forward\r\n\r\n4 - We currently have an API for payment gateways.  The API for version 1.5 is for adding modules to CE.\r\n\r\nThanks for the comments and I hope this answers your questions.",
            "isExternalEmail": true,
            "attachments": [

            ]
        }
    ],
    "commentcount": 2,
    "elapsed": "0.528",
    "message": ""
}