Your account must have the "activity" classification enabled to view activities. Administrators can enable this classification using the web interface.

Activity Managers can view, create, update and delete activities. Other users can only view their assigned activities (see Activity Assignments).

Activities associated with time entries can not be deleted. Consider making them inactive instead.

Show

Request

GET /activities/#{activity-id}.xml

Response

Status: 200 OK

<activity>
  <id type="integer">14</id>
  <name>Client interview</name>
  <active type="boolean">true</active>
  <code>INT</code>
  <description>Non-billable introductory interview</description>
  <url></url>
  <created-at type="datetime">2007-08-16T20:49:05Z</created-at>
  <updated-at type="datetime">2008-01-07T21:44:50Z</updated-at>
</activity>

List

Request

All activities:

GET /activities.xml

All active activities:

GET /activities/active.xml

All inactive activities:

GET /activities/inactive.xml

Activities assigned to the current user:

GET /activities/my_assignments.xml

Active activities assigned to the current user:

GET /activities/my_active_assignments.xml

Inactive activities assigned to the current user:

GET /activities/my_inactive_assignments.xml

Optional parameters

Specify start and end to request a specific range of items. For example:

GET /activities.xml?start=1&end=4

Response

Status: 200 OK

<activities total="6" end="4" start="1">
  <activity>
    ...
  </activity>
  ...
</activities>

Create

Request

POST /activities.xml

Include the following data with your request:

<activity>
  <!-- name (REQUIRED) -->
  <name>Client interview</name>
  <!-- active (optional boolean, default = true) -->
  <active>true</active>
  <!-- code (optional identifier) -->
  <code>INT</code>
  <!-- description (optional) -->
  <description>Non-billable introductory interview</description>
  <!-- url (optional external link) -->
  <url></url>
</activity>

Response

Status: 201 Created

<activity>
  <id type="integer">#{new-activity-id}</id>
  <name>Client interview</name>
  <active type="boolean">true</active>
  <code>INT</code>
  <description>Non-billable introductory interview</description>
  <url></url>
  <created-at type="datetime">2007-08-16T20:49:05Z</created-at>
  <updated-at type="datetime">2008-01-07T21:44:50Z</updated-at>
</activity>

Update

Request

PUT /activities/#{activity-id}.xml

Include ANY of the following data with your request:

<activity>
  <name>Client interview</name>
  <active>true</active>
  <code>INT</code>
  <description>Non-billable introductory interview</description>
  <url></url>
</activity>

Response

Status: 200 OK

Delete

Request

DELETE /activities/#{activity-id}.xml

Response

Status: 200 OK

Continue to Users...