Overview
This article provides details about the REST - UserSearch API call that Kayako Classic uses, including its field types, Arguments, and sample responses.
Information
POST /Base/UserSearch
Run a search on Users. You can search users from email, full name, phone, organization name, and user group.
Post Variables
Red = required
Name | Description |
query | The Search Query |
Response
<users>
<user>
<id>1</id>
<usergroupid>2</usergroupid>
<userrole>manager</userrole>
<userorganizationid>1</userorganizationid>
<salutation>Mr.</salutation>
<userexpiry>0</userexpiry>
<fullname>John Doe</fullname>
<email>john.doe@kayako.com</email><email>john@kayako.com</email>
<designation>CEO</designation>
<phone>123456789</phone>
<dateline><![CDATA[1296540309]]]]><![CDATA[></dateline>
<lastvisit><![CDATA[0]]]]><![CDATA[></lastvisit>
<isenabled><![CDATA[1]]]]><![CDATA[></isenabled>
<timezone>GMT</timezone>
<enabledst><![CDATA[0]]]]><![CDATA[></enabledst>
<slaplanid><![CDATA[0]]]]><![CDATA[></slaplanid>
<slaplanexpiry><![CDATA[0]]]]><![CDATA[></slaplanexpiry>
</user>
</users>