Developer

You're looking at the new v2 API docs. If you're maintaining an existing v1 API app, you may want to see the v1 docs instead.

Projects

List projects

List the authenticated user’s projects:

GET /user/projects

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
[
  {
    "id" : 3,
    "name" : "Web Standards Sherpa",
    "description" : "I did visual design and art direction for this project, working with the <a href=\"http://webstandards.org\">Web Standards Project</a> and Microsoft.",
    "shots_count" : 4,
    "created_at" : "2011-04-14T03:43:47Z",
    "updated_at" : "2012-04-04T22:39:53Z"
  }
]

Create a project

POST /projects

Parameters

Name Type Description
name string Required The name of the project.
description string The project description.

Response

Status: 201 Created
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
{
  "id" : 3,
  "name" : "Web Standards Sherpa",
  "description" : "I did visual design and art direction for this project, working with the <a href=\"http://webstandards.org\">Web Standards Project</a> and Microsoft.",
  "shots_count" : 4,
  "created_at" : "2011-04-14T03:43:47Z",
  "updated_at" : "2012-04-04T22:39:53Z"
}

Update a project

PUT /projects/:id

Parameters

Name Type Description
name string The name of the project.
description string The project description.

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
{
  "id" : 3,
  "name" : "Web Standards Sherpa",
  "description" : "I did visual design and art direction for this project, working with the <a href=\"http://webstandards.org\">Web Standards Project</a> and Microsoft.",
  "shots_count" : 4,
  "created_at" : "2011-04-14T03:43:47Z",
  "updated_at" : "2012-04-04T22:39:53Z"
}

Delete a project

DELETE /projects/:id

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
{
  "id" : 3,
  "name" : "Web Standards Sherpa",
  "description" : "I did visual design and art direction for this project, working with the <a href=\"http://webstandards.org\">Web Standards Project</a> and Microsoft.",
  "shots_count" : 4,
  "created_at" : "2011-04-14T03:43:47Z",
  "updated_at" : "2012-04-04T22:39:53Z"
}