Get tickets

Check all tickets


Method URI

Request Parameters

Parameter Type Description Required
HTTP headers: Authorization string Bearer + the token to access APIs Required
limitstart integer The offset for the returned quote data (default: 0) Optional
limitnum integer The number of records to return (default: 25) Optional
deptid integer Obtain tickets in a specific department Optional
email string Find tickets for a specific non-client email address Optional
status string Find tickets matching a specific status. Any configured status plus: Awaiting Reply, All Active Tickets, My Flagged Tickets Optional
subject string Find tickets containing a specific subject - uses approximate string matching. Optional

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
totalresults integer The total number of results available
startnumber integer The starting number for the returned results
numreturned integer The number of results returned
tickets array An array of tickets matching the criteria passed

Example Request (PHP Curl)


                    $curl = curl_init();
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;


Example Request (jQuery AJAX)

                    var form = new FormData();

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form

                    $.ajax(settings).done(function (response) {

Example Response (JSON payload)

                    "result": "success",
                    "totalresults": "1",
                    "startnumber": 0,
                    "numreturned": 1,
                    "tickets": {
                        "ticket": [
                                "id": "1",
                                "tid": "516757",
                                "deptid": "1",
                                "userid": "1",
                                "name": "Cynthia Reilly",
                                "email": "",
                                "cc": "",
                                "c": "KPqH7yG3",
                                "date": "2016-01-01 06:26:29",
                                "subject": "This is a sample ticket",
                                "status": "Answered",
                                "priority": "Medium",
                                "admin": "admin admin",
                                "attachment": "",
                                "lastreply": "2016-01-01 06:30:16",
                                "flag": "0",
                                "service": ""