Page tree
Skip to end of metadata
Go to start of metadata

POST /Base/UserSearch

API supported in version > 4.40.1148

 

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>
  • No labels

2 Comments

  1. Unknown User (lim_one)

    Hi! How should a query look like? For examle, if i want to select user with certain email, what should i write in query?

    1. Unknown User (mannb@hostmysite.com)

      Had the same issue, I used the syntax from TicketSearch and that seemed to work.