REST API Reference
Users

Users in Freshdesk can mean contacts, customers, helpdesk administrators or agents.


Viewing users

Below is a sample GET request for viewing all the users

curl -u {username}:{password} http://{yourhelpdeskdomain}/contacts.xml

Sample Output

<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
  <user>
	<active type="boolean">false</active>
	<created-at type="datetime">2011-10-29T16:38:23+05:30</created-at>
	<current-login-at type="datetime" nil="true"></current-login-at>
	<current-login-ip nil="true"></current-login-ip>
	<customer-id type="integer" nil="true"></customer-id>
	<deleted type="boolean">false</deleted>
	<delta type="boolean">true</delta>
	<description nil="true"></description>
	<email>rachel@freshdesk.com</email>
	<failed-login-count type="integer">0</failed-login-count>
	<fb-profile-id nil="true"></fb-profile-id>
	<id type="integer">2</id>
	<import-id type="integer" nil="true"></import-id>
	<job-title nil="true"></job-title>
	<last-login-at type="datetime" nil="true"></last-login-at>
	<last-login-ip nil="true"></last-login-ip>
	<last-seen-at type="datetime" nil="true"></last-seen-at>
	<login-count type="integer">0</login-count>
	<mobile nil="true"></mobile>
	<name>Rachel</name>
	<phone nil="true"></phone>
	<posts-count type="integer">0</posts-count>
	<second-email nil="true"></second-email>
	<time-zone>Chennai</time-zone>
	<twitter-id nil="true"></twitter-id>
	<updated-at type="datetime">2011-10-29T16:38:23+05:30</updated-at>
	<user-role type="integer">3</user-role>
  </user>
</users>


Creating users

Below is a sample POST request for creating a user

curl -u {username}:{password} -H "Content-Type: application/xml" -d
"<user><name>{UserName}</name>
<email>{user@customercompany.com}</email></user>" -X POST 
http://{yourhelpdesk.freshdesk.com}/contacts.xml

Sample Output

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <active type="boolean">false</active>
  <created-at type="datetime">2011-11-13T22:41:35+05:30</created-at>
  <current-login-at type="datetime" nil="true"></current-login-at>
  <current-login-ip nil="true"></current-login-ip>
  <customer-id type="integer" nil="true"></customer-id>
  <deleted type="boolean">false</deleted>
  <delta type="boolean">true</delta>
  <description nil="true"></description>
  <email>kiran1@freshdesk.com</email>
  <failed-login-count type="integer">0</failed-login-count>
  <fb-profile-id nil="true"></fb-profile-id>
  <id type="integer">5</id>
  <import-id type="integer" nil="true"></import-id>
  <job-title nil="true"></job-title>
  <last-login-at type="datetime" nil="true"></last-login-at>
  <last-login-ip nil="true"></last-login-ip>
  <last-seen-at type="datetime" nil="true"></last-seen-at>
  <login-count type="integer">0</login-count>
  <mobile nil="true"></mobile>
  <name>kiran</name>
  <phone nil="true"></phone>
  <posts-count type="integer">0</posts-count>
  <second-email nil="true"></second-email>
  <time-zone>Chennai</time-zone>
  <twitter-id nil="true"></twitter-id>
  <updated-at type="datetime">2011-11-13T22:41:35+05:30</updated-at>
  <user-role type="integer">3</user-role>
</user>


Modifying users

Below is a sample PUT request for modifying a user

curl -u {username}:{password} -H "Content-Type: application/xml" -d
"<user><name>{CustomerName}</name>
<email>{Customer@theirdomain.com}</email></user>" -X PUT 
http://{yourhelpdesk.freshdesk.com}/contacts/{id}.xml


Deleting users

Below is a sample DELETE request for deleting a user

curl -u {username}:{password} -X 
DELETE http://{yourhelpdesk.freshdesk.com}/helpdesk/contacts/{id}.xml


Viewing a particular user

Below is a sample GET request for viewing a particular user

curl -u {username}:{password} http://{yourhelpdeskdomain}/contacts/{id}.xml

Sample Output

<user>
  <active type="boolean">false</active>
  <created-at type="datetime">2011-11-13T22:41:35+05:30</created-at>
  <current-login-at type="datetime" nil="true"></current-login-at>
  <current-login-ip nil="true"></current-login-ip>
  <customer-id type="integer" nil="true"></customer-id>
  <deleted type="boolean">false</deleted>
  <delta type="boolean">true</delta>
  <description nil="true"></description>
  <email>kiran1@freshdesk.com</email>
  <failed-login-count type="integer">0</failed-login-count>
  <fb-profile-id nil="true"></fb-profile-id>
  <id type="integer">5</id>
  <import-id type="integer" nil="true"></import-id>
  <job-title nil="true"></job-title>
  <last-login-at type="datetime" nil="true"></last-login-at>
  <last-login-ip nil="true"></last-login-ip>
  <last-seen-at type="datetime" nil="true"></last-seen-at>
  <login-count type="integer">0</login-count>
  <mobile nil="true"></mobile>
  <name>kiran</name>
  <phone nil="true"></phone>
  <posts-count type="integer">0</posts-count>
  <second-email nil="true"></second-email>
  <time-zone>Chennai</time-zone>
  <twitter-id nil="true"></twitter-id>
  <updated-at type="datetime">2011-11-13T22:41:35+05:30</updated-at>
  <user-role type="integer">3</user-role>
</user>