Projects

List Projects - GET /projects.xml

Retrieve a list of projects for the current account.

Response:

1
2
3
4
5
6
7
8
9


<projects>
  <project>
    ...
  </project>
  <project>
    ...
  </project>
</projects>

Get Project - GET /projects/#{project_id}.xml

Response:

1
2
3
4
5
6
7
8
9
10
11
12


<project>
  <archived type="boolean">false</archived>
  <created-at type="datetime">2006-07-23T21:13:24Z</created-at>
  <id type="integer">2</id>
  <name>Lighthouse</name>
  <open-tickets-count type="integer">31</open-tickets-count>
  <permalink>lighthouse</permalink>
  <public type="boolean">false</public>
  <default-assigned-user-id type="integer">3</default-assigned-user-id>
  <default-milestone-id type="integer">19</default-milestone-id>
</project>

New Project - GET /projects/new.xml

This gives you the initial state for an empty project.

Response:

1
2
3
4
5
6
7
8
9
10
11


<project>
  <archived type="boolean"></archived>
  <created-at type="datetime"></created-at>
  <name></name>
  <open-tickets-count type="integer">0</open-tickets-count>
  <permalink></permalink>
  <public type="boolean">false</public>
  <default-assigned-user-id type="integer"></default-assigned-user-id>
  <default-milestone-id type="integer"></default-milestone-id>
</project>

Create Project - POST /projects.xml

Creates a project. Note that even though the above XML shows more attributes, only the name, archived, and public attributes are allowed for creating or updating projects. Missing attributes will remain their default, as shown in the new project request above.

Request:

1
2
3
4
5
6


<project>
  <archived type="boolean">false</archived>
  <name>Lighthouse</name>
  <public type="boolean">false</public>
</project>

Response:

  • HTTP Status: 201 Created
  • Location: http://activereload.lighthouseapp.com/projects/5.xml
1
2
3
4
5
6
7
8
9


<project>
  <archived type="boolean">false</archived>
  <created-at type="datetime">2006-07-23T21:13:24Z</created-at>
  <name>Lighthouse</name>
  <open-tickets-count type="integer">0</open-tickets-count>
  <permalink>lighthouse</permalink>
  <public type="boolean">false</public>
</project>

Update Project - PUT /projects/#{project_id}.xml

Update an existing project. You can leave out fields to keep them unchanged.

Request:

1
2
3
4
5
6


<project>
  <archived type="boolean">false</archived>
  <name>Lighthouse Reloaded</name>
  <public type="boolean">false</public>
</project>

Response:

  • HTTP Status: 200 OK

Delete Project - DELETE /projects/#{project_id}.xml

This action should not be taken lightly. This will not only delete the project, but all the tickets and messages in it.

Response:

  • HTTP Status: 200 OK
« The Basics | API | Tickets »

Visit us in the forums

If you can't find what you're looking for here? visit us in the forums.