Overview

This article provides details about the REST - User API call that Kayako Classic uses, including its field types, arguments, and responses. 

• GET /Base/User/Filter OR GET /Base/User/Filter/$marker$/$maxitems$
  • Response
• GET /Base/User/$id$
  • Arguments
  • Response
• PUT /Base/User/$id$
  • Arguments
  • Response
• POST /Base/User
  • Arguments
  • Response
• DELETE /Base/User/$id$
  • Arguments

 

Information

GET /Base/User/Filter OR GET /Base/User/Filter/$marker$/$maxitems$

Retrieve a list of all users in the help desk starting from a marker (user id) till the item fetch limit is reached (by default this is 1000).

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>1296540309</dateline>
  <lastvisit>0</lastvisit>
  <isenabled>1</isenabled>
  <timezone>GMT</timezone>
  <enabledst>0</enabledst>
  <slaplanid>0</slaplanid>
  <slaplanexpiry>0</slaplanexpiry>
  </user>
</users>

 

GET /Base/User/$id$

Retrieve the user identified by $id$.

Arguments

Red = required

Name	Description
$id$	The unique numeric identifier of the user	Required

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>1296540309</dateline>
  <lastvisit>0</lastvisit>
  <isenabled>1</isenabled>
  <timezone>GMT</timezone>
  <enabledst>0</enabledst>
  <slaplanid>0</slaplanid>
  <slaplanexpiry>0</slaplanexpiry>
 </user>
</users>

 

PUT /Base/User/$id$

Update the user identified by $id$.

Arguments

Red = required

Name	Description
fullname	The full name of User	Required
usergroupid	The User Group ID (registered group) to assign to this User.	Optional
email	The Email Address of User, you can send multiple email addresses by using "email[]" as the key	Optional
userorganizationid	The User Organization ID	Optional
salutation	The User Salutation, available options are: Mr., Ms., Mrs., Dr.	Optional
designation	The User Designation/Title	Optional
phone	The Phone Number	Optional
isenabled	Toggle whether the user is to be enabled/disabled	Optional
userrole	The User Role, available options are: user, manager. Default: user	Optional
timezone	The Time Zone	Optional
enabledst	Enable Daylight Savings?	Optional
slaplanid	The SLA Plan ID to assign to the user	Optional
slaplanexpiry	The SLA Plan Expiry, 0 = never expires	Optional
userexpiry	The User Expiry, 0 = never expires	Optional

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>1296540309</dateline>
   <lastvisit>0</lastvisit>
   <isenabled>1</isenabled>
   <timezone>GMT</timezone>
   <enabledst>0</enabledst>
   <slaplanid>0</slaplanid>
   <slaplanexpiry>0</slaplanexpiry>
  </user>
</users>

 

POST /Base/User

Create a new User record.

Arguments

Red = required

Name	Description
fullname	The full name of User.	Required
usergroupid	The User Group ID to assign to this User.	Required
password	The User Password	Required
email	The Email Address of User, you can send multiple email addresses by using "email[]" as the key	Required
userorganizationid	The User Organization ID	Optional
salutation	The User Salutation, available options are: Mr., Ms., Mrs., Dr.	Optional
designation	The User Designation/Title	Optional
phone	The Phone Number	Optional
isenabled	Toggle whether the user is to be enabled/disabled	Optional
userrole	The User Role, available options are: user, manager. Default: user	Optional

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>1296540309</dateline>
   <lastvisit>0</lastvisit>
   <isenabled>1</isenabled>
   <timezone>GMT</timezone>
   <enabledst>0</enabledst>
   <slaplanid>0</slaplanid>
   <slaplanexpiry>0</slaplanexpiry>
  </user>
</users>

 

DELETE /Base/User/$id$

Delete the user identified by $id$.

Arguments

Red = required

Name	Description
$id$	The unique numeric identifier of the user	Required