Overview
Statuses
Time Entries
Groups
Agendas
Memberships
Users
Harvest Credentials

Questions? support@harvestapp.com

Agendas

Show the group's agenda

GET /groups/#{group_id}/agenda

Returns an as-typed version of the agenda as well as a Textile-parsed version.

HTTP Response: 200 OK

XML response:

<hash>
  <group-id type="integer">25</group-id>
  <agenda>"goog":http://google.com

* Yes
* We
* Can
* (Search)</agenda>
  <agenda-html>&lt;p&gt;&lt;a href="http://google.com"&gt;goog&lt;/a&gt;&lt;/p&gt;
&lt;ul&gt;
    &lt;li&gt;Yes&lt;/li&gt;
    &lt;li&gt;We&lt;/li&gt;
    &lt;li&gt;Can&lt;/li&gt;
    &lt;li&gt;(Search)&lt;/li&gt;
&lt;/ul&gt;</agenda-html>
</hash>

JSON response:

{"group_id": 25, "agenda": "\"goog\":http://google.com\n\n* Yes\n* We\n* Can\n* (Search)",
 "agenda_html": "<p><a href=\"http://google.com\">goog</a></p>\n<ul>\n\t<li>Yes</li>\n\t
 <li>We</li>\n\t<li>Can</li>\n\t<li>(Search)</li>\n</ul>"

Show all agendas for the users of a given group

GET /groups/#{group_id}/user_agendas

Returns as-typed versions of the agendas as well as Textile-parsed versions.

HTTP Response: 200 OK

XML response:

<records type="array">
  <record>
    <user-id type="integer">25</user-id>
    <agenda>"goog":http://google.com

  * Yes
  * We
  * Can
  * (Search)</agenda>
    <agenda-html>&lt;p&gt;&lt;a href="http://google.com"&gt;goog&lt;/a&gt;&lt;/p&gt;
  &lt;ul&gt;
      &lt;li&gt;Yes&lt;/li&gt;
      &lt;li&gt;We&lt;/li&gt;
      &lt;li&gt;Can&lt;/li&gt;
      &lt;li&gt;(Search)&lt;/li&gt;
  &lt;/ul&gt;</agenda-html>
  </record>
  <record>
    <user-id type="integer">26</user-id>
    <agenda>Fawlty concierge victory!</agenda>
    <agenda-html>&lt;p&gt;Fawlty concierge victory!&lt;/p&gt;</agenda-html>
  </record>
</records>

JSON response:

[{"user_id": 25, "agenda": "\"goog\":http://google.com\n\n* Yes\n* We\n* Can\n* (Search)",
 "agenda_html": "<p><a href=\"http://google.com\">goog</a></p>\n<ul>\n\t<li>Yes</li>\n\t
 <li>We</li>\n\t<li>Can</li>\n\t<li>(Search)</li>\n</ul>"},
 {"user_id": 26, "agenda": "Fawlty concierge victory!",
 "agenda_html": "<p>Fawlty concierge victory!</p>"}]

Show authenticated user's agenda for a given group

GET /groups/#{group_id}/my_agenda

Returns an as-typed version of the agenda as well as a Textile-parsed version.

HTTP Response: 200 OK

XML response:

<hash>
  <user-id type="integer">25</user-id>
  <agenda>"goog":http://google.com

* Yes
* We
* Can
* (Search)</agenda>
  <agenda-html>&lt;p&gt;&lt;a href="http://google.com"&gt;goog&lt;/a&gt;&lt;/p&gt;
&lt;ul&gt;
    &lt;li&gt;Yes&lt;/li&gt;
    &lt;li&gt;We&lt;/li&gt;
    &lt;li&gt;Can&lt;/li&gt;
    &lt;li&gt;(Search)&lt;/li&gt;
&lt;/ul&gt;</agenda-html>
</hash>

JSON response:

{"user_id": 25, "agenda": "\"goog\":http://google.com\n\n* Yes\n* We\n* Can\n* (Search)",
 "agenda_html": "<p><a href=\"http://google.com\">goog</a></p>\n<ul>\n\t<li>Yes</li>\n\t
 <li>We</li>\n\t<li>Can</li>\n\t<li>(Search)</li>\n</ul>"

Update group's agenda

PUT /groups/#{group_id}/agenda

Textile markup may be used when updating the agenda. The authenticated user must be a group admin to update the group's agenda.

HTTP Response: 200 OK
Location: /groups/#{group_id}/agenda

Sample XML PUT:

<agenda>
* Yes
* We
* Can
* ("Search":http://google.com)
</agenda>

Sample JSON PUT:

{"agenda": "* Yes\n* We\n* Can\n(\"Search\":http://google.com)"}

Update authenticated user's agenda for the given group

PUT /groups/#{group_id}/my_agenda

Textile markup may be used when updating the agenda.

HTTP Response: 200 OK
Location: /groups/#{group_id}/my_agenda

Sample XML PUT:

<agenda>
* Yes
* We
* Can
* ("Search":http://google.com)
</agenda>

Sample JSON PUT:

{"agenda": "* Yes\n* We\n* Can\n(\"Search\":http://google.com)"}