Overview
This article provides details about the REST - TicketSearch API call that Kayako Classic uses, including its field types, arguments, and responses.
Information
POST /Tickets/TicketSearch
Note: API supported in version > v4.01.220
Note: Run a search on tickets. You can combine the search factors to make the search span multiple areas. For example, to search the full name, contents, and email you can send the arguments as:
query=John&fullname=1&email=1&contents=1
Post Variables
Red = required
Name |
Description |
| query | The Search Query |
| ticketid | If value is '1' then search the Ticket ID & Mask ID |
| contents | If value is '1' then search the Ticket Post Contents |
| author | If value is '1' then search the Full Name & Email |
| If value is '1' then search the Email Address (Ticket & Posts) | |
| creatoremail | If value is '1' then search the Email Address (only Tickets) |
| fullname | If value is '1' then search the Full Name |
| notes | If value is '1' then search the Ticket Notes |
| usergroup | If value is '1' then search the User Group |
| userorganization | If value is '1' then search the User Organization |
| user | If value is '1' then search the User (Full Name, Email) |
| tags | If value is '1' then search the Ticket Tags |
Response
<tickets>
<ticket id="2" flagtype="0">
<displayid>OLJ-171-16930</displayid>
<departmentid>2</departmentid>
<statusid>1</statusid><priorityid>1</priorityid>
<typeid>1</typeid><userid>1</userid>
<userorganization>Test</userorganization>
<userorganizationid>1</userorganizationid>
<ownerstaffid>0</ownerstaffid><ownerstaffname /><fullname>Varun Shoor</fullname>
<email>varun.shoor@kayako.com</email><lastreplier>Varun Shoor</lastreplier>
<subject>This is just a test</subject>
<creationtime>1297840147</creationtime>
<lastactivity>1297840147</lastactivity>
<laststaffreply>0</laststaffreply><lastuserreply>1297840147</lastuserreply>
<slaplanid>1</slaplanid><nextreplydue>1297883347</nextreplydue>
<resolutiondue>1298012947</resolutiondue><replies>0</replies>
<ipaddress>127.0.0.1</ipaddress>
<creator>2</creator><creationmode>1</creationmode>
<creationtype>1</creationtype><isescalated>0</isescalated>
<escalationruleid>0</escalationruleid>
<tags>test tag client</tags>
<watcher staffid="1" name="Varun Shoor" /><workflow id="1" title="Close Ticket" />
<note type="ticket" id="1" ticketid="2" notecolor="1"creatorstaffid="1" forstaffid="0" creatorstaffname="Varun Shoor"creationdate="1297842417">This is a ticket note</note>
<note type="user" id="1" userid="1" notecolor="1"creatorstaffid="1" forstaffid="0" creatorstaffname="Varun Shoor"creationdate="1297842435">This is a test User note</note>
<note type="userorganization" id="1" userorganizationid="1"notecolor="1" creatorstaffid="1" forstaffid="0" creatorstaffname="VarunShoor" creationdate="1297842447">This is a test User Organizationnote</note>
<note type="timetrack" id="1" ticketid="2" timeworked="1800"timebillable="1800" billdate="1297842420" workdate="1297842420"workerstaffid="1" workerstaffname="Varun Shoor" creatorstaffid="1"creatorstaffname="Varun Shoor" notecolor="1">This is a test time trackentry for thirty minutes</note>
<posts><post><id>2</id><ticketid>2</ticketid><dateline>1297840147</dateline><userid>1</userid><fullname>Varun Shoor</fullname><email>varun.shoor@kayako.com</email><emailto /><ipaddress>127.0.0.1</ipaddress><hasattachments>0</hasattachments><creator>2</creator>
<isthirdparty>0</isthirdparty>
<ishtml>0</ishtml><isemailed>0</isemailed>
<staffid>0</staffid><issurveycomment>0</issurveycomment>
<contents><![CDATA[I am justtesting]]]]><![CDATA[></contents></post>
</posts>
</ticket>
</tickets>