Forums


Forums Properties

Below are the Forums properties which have fixed values:

Forum Type

How to 1
Ideas 2
Problems 3
Announcements 4

Forum Visibility

Anyone 1
Logged in users 2
Agents 3

Topic Stamp

Planned 1
Implemented 2
Taken 3



Viewing Categories

Below is a request to view all the categories in the Forums:

curl "http://{yourhelpdesk.freshdesk.com}/categories.xml"

Below is the sample output for the above request:

<?xml version="1.0" encoding="UTF-8"?>
<forum-categories type="array">
  <forum-category>
    <created-at type="datetime">2011-03-15T02:23:15-07:00</created-at>
    <description>Welcome to the Freshdesk community forums</description>
    <id type="integer">2</id>
    <name>Freshdesk Forums</name>
   <updated-at type="datetime">2011-03-21T02:42:58-07:00</updated-at>
  </forum-category>
....
</forum-categories>



Viewing Forums in a Category

Below is the request for viewing all the forums in the category named 'Freshdesk Forums'(id=2)

curl "http://{yourhelpdesk.freshdesk.com}/categories/{id}.xml"

Below is the output for the above request:

<?xml version="1.0" encoding="UTF-8"?>
<forums type="array">
  <forum>
    <description>General helpdesk announcements to the customers.</description>
    <description-html>
     <p>General helpdesk announcements to the customers.</p>
    </description-html>
    <forum-category-id type="integer">2</forum-category-id>
   <forum-type type="integer">4</forum-type>
    <id type="integer">5</id>
    <name>Announcements</name>
    <position type="integer">5</position>
    <posts-count type="integer">0</posts-count>
    <topics-count type="integer">0</topics-count>
 </forum>
  <forum>
    <account-id type="integer">2</account-id>
    <description>Customers can voice their ideas here.</description>
    <description-html><p>Customers can voice their ideas here.</p>
    </description-html>
    <forum-category-id type="integer">2</forum-category-id>
   <forum-type type="integer">2</forum-type>
    <id type="integer">6</id>
    <name>Feature Requests</name>
    <position type="integer">6</position>
    <posts-count type="integer">11</posts-count>
    <topics-count type="integer">7</topics-count>
 </forum>
  ...
</forums>



Viewing Topics in a Forum

Below is the request for viewing all the topics in the forum "Feature Requests" (id=6)

curl “http://{yourhelpdesk.freshdesk.com}/categories/{category_id}/forums/{id}.xml”

Below is the output for the above request:

<?xml version="1.0" encoding="UTF-8"?>
<forum>
  <description>Customers can voice their ideas here.</description>
  <description-html><p>Customers can voice their ideas here.</p></description-html>
  <forum-category-id type="integer">2</forum-category-id>
  <forum-type type="integer">2</forum-type>
 <id type="integer">6</id>
  <name>Feature Requests</name>
  <position type="integer">6</position>
  <posts-count type="integer">11</posts-count>
  <topics-count type="integer">7</topics-count>
  <forum-category>
    <created-at type="datetime">2011-03-15T02:23:15-07:00</created-at>
    <description>Welcome to the Freshdesk community forums</description>
    <id type="integer">2</id>
    <name>Freshdesk Forums</name>
    <updated-at type="datetime">2011-03-21T02:42:58-07:00</updated-at>
 </forum-category>
  <topics type="array">
    <topic>
     <created-at type="datetime">2011-04-06T07:38:15-07:00</created-at>
     <delta type="boolean">false</delta>
     <forum-id type="integer">6</forum-id>
     <hits type="integer">4</hits>
      <id type="integer">41</id>
      <last-post-id type="integer">66</last-post-id>
      <locked type="boolean">false</locked>
      <posts-count type="integer">0</posts-count>
      <replied-at type="datetime">2011-04-06T07:38:15-07:00</replied-at>
     <replied-by type="integer">464</replied-by>
      <stamp-type type="integer" nil="true"></stamp-type>
      <sticky type="integer">0</sticky>
      <title>Group tickets by type</title>
      <updated-at type="datetime">2011-04-06T07:38:15-07:00</updated-at>
      <user-id type="integer">464</user-id>
   </topic>
    <topic>
      <created-at type="datetime">2011-04-05T11:02:51-07:00</created-at>
      <delta type="boolean">false</delta>
      <forum-id type="integer">6</forum-id>
      <hits type="integer">15</hits>
     <id type="integer">38</id>
      <last-post-id type="integer">63</last-post-id>
      <locked type="boolean">false</locked>
      <posts-count type="integer">0</posts-count>
      <replied-at type="datetime">2011-04-05T11:02:51-07:00</replied-at>
      <replied-by type="integer">464</replied-by>
     <stamp-type type="integer" nil="true"></stamp-type>
      <sticky type="integer">0</sticky>
      <title>Reorderable dropdown choices</title>
      <updated-at type="datetime">2011-04-05T11:02:51-07:00</updated-at>
      <user-id type="integer">464</user-id>
    </topic>
    <topic>
      <created-at type="datetime">2011-03-30T20:45:59-07:00</created-at>
      <delta type="boolean">false</delta>
      <forum-id type="integer">6</forum-id>
      <hits type="integer">35</hits>
      <id type="integer">33</id>
     <last-post-id type="integer">52</last-post-id>
      <locked type="boolean">false</locked>
      <posts-count type="integer">0</posts-count>
      <replied-at type="datetime">2011-03-30T20:45:59-07:00</replied-at>
      <replied-by type="integer">277</replied-by>
      <stamp-type type="integer" nil="true"></stamp-type>
     <sticky type="integer">0</sticky>
      <title>Ticket Status Page</title>
      <updated-at type="datetime">2011-03-30T20:45:59-07:00</updated-at>
      <user-id type="integer">277</user-id>
    </topic>
    <topic>
      <created-at type="datetime">2011-03-26T22:43:48-07:00</created-at>
      <delta type="boolean">false</delta>
      <forum-id type="integer">6</forum-id>
      <hits type="integer">36</hits>
      <id type="integer">30</id>
      <last-post-id type="integer">48</last-post-id>
     <locked type="boolean">false</locked>
      <posts-count type="integer">0</posts-count>
      <replied-at type="datetime">2011-03-26T22:43:48-07:00</replied-at>
      <replied-by type="integer">347</replied-by>
      <stamp-type type="integer" nil="true"></stamp-type>
      <sticky type="integer">0</sticky>
     <title>Ajax-ify the interface</title>
      <updated-at type="datetime">2011-03-26T22:43:48-07:00</updated-at>
      <user-id type="integer">347</user-id>
    </topic>
    <topic>
      <created-at type="datetime">2011-03-25T21:03:26-07:00</created-at>
      <delta type="boolean">false</delta>
      <forum-id type="integer">6</forum-id>
      <hits type="integer">47</hits>
      <id type="integer">28</id>
      <last-post-id type="integer">46</last-post-id>
      <locked type="boolean">false</locked>
     <posts-count type="integer">3</posts-count>
      <replied-at type="datetime">2011-03-26T08:16:09-07:00</replied-at>
      <replied-by type="integer">347</replied-by>
      <stamp-type type="integer">1</stamp-type>
      <sticky type="integer">0</sticky>
      <title>Take action on tickets via e-mail commands</title>
     <updated-at type="datetime">2011-04-01T06:31:30-07:00</updated-at>
      <user-id type="integer">347</user-id>
    </topic>
    ...
  </topics>
</forum>



Viewing all Posts in a Topic

Below is the request to view all posts under a topic named “Facebook Integration” (id=26)

curl “http://{yourhelpdesk.freshdesk.com}/categories/{category_id}/
forums/{forum_id}/topics/{id}.xml”

Below is the output for the above request:

<?xml version="1.0" encoding="UTF-8"?>
<posts type="array">
  <post>
    <answer type="boolean">false</answer>
    <body>The ability to receive tickets directly from facebook using a Freshdesk 
    app built specifically for facebook.</body>
    <body-html><p>The ability to receive tickets directly from facebook using a 
    Freshdesk app built specifically for facebook.</p></body-html>
   <created-at type="datetime">2011-03-24T18:50:52-07:00</created-at>
    <forum-id type="integer">6</forum-id>
    <id type="integer">40</id>
    <topic-id type="integer">26</topic-id>
    <updated-at type="datetime">2011-03-24T18:50:52-07:00</updated-at>
    <user-id type="integer">277</user-id>
 </post>
  <post>
    <answer type="boolean">false</answer>
    <body>We will take up Facebook app development after the current set of features 
    are complete. We also want to hear from other customers on how important is it 
    for them to have a Facebook app. Girish</body>
    <body-html><p>We will take up Facebook app development after the current 
    set of features are complete. We also want to hear from other customers on how 
    important is it for them to have a Facebook app.</p><p>Girish</p></body-html>
    <created-at type="datetime">2011-03-26T05:47:01-07:00</created-at>
    <forum-id type="integer">6</forum-id>
    <id type="integer">44</id>
    <topic-id type="integer">26</topic-id>
    <updated-at type="datetime">2011-03-26T05:47:01-07:00</updated-at>
   <user-id type="integer">21</user-id>
  </post>
</posts>