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.

Shots

List shots

List the authenticated user’s shots.

GET /user/shots

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
[
  {
    "id" : 471756,
    "title" : "Sasquatch",
    "description" : "<p>Quick, messy, five minute sketch of something that might become a fictional something.</p>",
    "width" : 400,
    "height" : 300,
    "images" : {
      "hidpi" : null,
      "normal" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch.png",
      "teaser" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch_teaser.png"
    },
    "published_at" : "2012-03-15T01:52:33Z",
    "updated_at" : "2012-03-15T02:12:57Z",
    "html_url" : "https://dribbble.com/shots/471756-Sasquatch",
    "animated" : false,
    "tags" : [
      "fiction",
      "sasquatch",
      "sketch",
      "wip"
    ],
    "attachments" : [
      {
        "id" : 206165,
        "url" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/1412410/attachments/206165/weathered-ball-detail.jpg",
        "thumbnail_url" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/1412410/attachments/206165/thumbnail/weathered-ball-detail.jpg",
        "size" : 116375,
        "content_type" : "image/jpeg",
        "created_at" : "2014-02-07T16:35:09Z"
      }
    ],
    "projects" : [
      {
        "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"
      }
    ],
    "team" : {
      "id" : 39,
      "name" : "Dribbble",
      "login" : "dribbble",
      "html_url" : "https://dribbble.com/dribbble",
      "avatar_url" : "https://d13yacurqjgara.cloudfront.net/users/39/avatars/normal/apple-flat-precomposed.png?1388527574",
      "bio" : "Show and tell for designers. This is Dribbble on Dribbble.",
      "location" : "Salem, MA",
      "links" : {
        "web" : "http://dribbble.com",
        "twitter" : "https://twitter.com/dribbble"
      },
      "type" : "Team",
      "created_at" : "2009-08-18T18:34:31Z",
      "updated_at" : "2014-02-14T22:32:11Z"
    },
    "low_profile" : false
  }
]

List currently popular shots. Note: This is available only to select applications with our approval.

GET /popular_shots

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
[
  {
    "id" : 471756,
    "title" : "Sasquatch",
    "description" : "<p>Quick, messy, five minute sketch of something that might become a fictional something.</p>",
    "images" : {
      "hidpi" : null,
      "normal" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch.png",
      "teaser" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch_teaser.png"
    },
    "published_at" : "2012-03-15T01:52:33Z",
    "html_url" : "https://dribbble.com/shots/471756-Sasquatch",
    "height" : 300,
    "width" : 400
  }
]

Get a shot

This endpoint returns only shots owned by the currently authenticated user.

GET /shots/:id

Images

The normal image is typically 400x300, but may be smaller if created before October 4th, 2012. The width and height provide the size of the normal image.

The hidpi image may or may not be present, but will always be 800x600.

The teaser image is typically 200x150, but may be smaller if created before October 4th, 2012.

If the animated attribute of the shot is true, the highest resolution image available (hidpi or normal) will be animated (smaller images will be stills).

Team

If the shot is also associated with a team, the team attribute will be included. Otherwise, the attribute will be omitted.

Scheduling

Shots which have been scheduled to publish in the future won’t include the published_at timestamp, but will instead include scheduled_for.

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
{
  "id" : 471756,
  "title" : "Sasquatch",
  "description" : "<p>Quick, messy, five minute sketch of something that might become a fictional something.</p>",
  "width" : 400,
  "height" : 300,
  "images" : {
    "hidpi" : null,
    "normal" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch.png",
    "teaser" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch_teaser.png"
  },
  "published_at" : "2012-03-15T01:52:33Z",
  "updated_at" : "2012-03-15T02:12:57Z",
  "html_url" : "https://dribbble.com/shots/471756-Sasquatch",
  "animated" : false,
  "tags" : [
    "fiction",
    "sasquatch",
    "sketch",
    "wip"
  ],
  "attachments" : [
    {
      "id" : 206165,
      "url" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/1412410/attachments/206165/weathered-ball-detail.jpg",
      "thumbnail_url" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/1412410/attachments/206165/thumbnail/weathered-ball-detail.jpg",
      "size" : 116375,
      "content_type" : "image/jpeg",
      "created_at" : "2014-02-07T16:35:09Z"
    }
  ],
  "projects" : [
    {
      "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"
    }
  ],
  "team" : {
    "id" : 39,
    "name" : "Dribbble",
    "login" : "dribbble",
    "html_url" : "https://dribbble.com/dribbble",
    "avatar_url" : "https://d13yacurqjgara.cloudfront.net/users/39/avatars/normal/apple-flat-precomposed.png?1388527574",
    "bio" : "Show and tell for designers. This is Dribbble on Dribbble.",
    "location" : "Salem, MA",
    "links" : {
      "web" : "http://dribbble.com",
      "twitter" : "https://twitter.com/dribbble"
    },
    "type" : "Team",
    "created_at" : "2009-08-18T18:34:31Z",
    "updated_at" : "2014-02-14T22:32:11Z"
  },
  "low_profile" : false
}

Create a shot

POST /shots

Creating a shot requires the user to be authenticated with the upload scope. The authenticated user must also be a player or team.

Parameters

Name Type Description
image file Required. The image file.

It must be exactly 400x300 or 800x600, no larger than eight megabytes, and be a GIF, JPG, or PNG.
title string Required. The title of the shot.
description string A description of the shot.
low_profile boolean Specify true if the shot is Low Profile.
rebound_source_id integer An ID of a shot that the new shot is a rebound of.

The shot must be reboundable and by a user not blocking the authenticated user.
scheduled_for timestamp Timestamp to publish the shot. If omitted, shot is published immediately. Must be in ISO 8601 format.

The authenticated user must be a pro, a team, or a member of a team.
tags array Tags for the shot.

Limited to a maximum of 12 tags.
team_id integer An ID of a team to associate the shot with.

The authenticated user must either be a member of the team or be authenticated as the same team.

Response

Creating a shot happens asynchronously. After creation the returned location will return a 404 Not Found until processing is completed.

Status: 202 Accepted
Location: https://api.dribbble.com/v2/shots/471756
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59

Update a shot

PUT /shots/:id

Updating a shot requires the user to be authenticated with the upload scope. The authenticated user must also own the shot.

Parameters

Name Type Description
description string A description of the shot.
low_profile boolean Specify true if the shot is Low Profile.
scheduled_for timestamp If the shot is not already published, will reschedule the shot to publish at the timestamp provided. Timestamp must be in ISO 8601 format.

The authenticated user must be a pro, a team, or a member of a team.
tags array Tags for the shot.

Limited to a maximum of 12 tags. If any existing tags are not provided they will be removed.
team_id integer An ID of a team to associate the shot with.

The authenticated user must be on the team. If any empty value is provided the team association will be removed.
title string The title of the shot.

Example

{
  "title" : "Sasquatch",
  "description" : "Quick, messy, five minute sketch of something that might become a fictional something.",
  "tags" : [
    "fiction",
    "sasquatch",
    "sketch",
    "wip"
  ]
}

Response

Status: 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
{
  "id" : 471756,
  "title" : "Sasquatch",
  "description" : "<p>Quick, messy, five minute sketch of something that might become a fictional something.</p>",
  "width" : 400,
  "height" : 300,
  "images" : {
    "hidpi" : null,
    "normal" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch.png",
    "teaser" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/471756/sasquatch_teaser.png"
  },
  "published_at" : "2012-03-15T01:52:33Z",
  "updated_at" : "2012-03-15T02:12:57Z",
  "html_url" : "https://dribbble.com/shots/471756-Sasquatch",
  "animated" : false,
  "tags" : [
    "fiction",
    "sasquatch",
    "sketch",
    "wip"
  ],
  "attachments" : [
    {
      "id" : 206165,
      "url" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/1412410/attachments/206165/weathered-ball-detail.jpg",
      "thumbnail_url" : "https://d13yacurqjgara.cloudfront.net/users/1/screenshots/1412410/attachments/206165/thumbnail/weathered-ball-detail.jpg",
      "size" : 116375,
      "content_type" : "image/jpeg",
      "created_at" : "2014-02-07T16:35:09Z"
    }
  ],
  "projects" : [
    {
      "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"
    }
  ],
  "team" : {
    "id" : 39,
    "name" : "Dribbble",
    "login" : "dribbble",
    "html_url" : "https://dribbble.com/dribbble",
    "avatar_url" : "https://d13yacurqjgara.cloudfront.net/users/39/avatars/normal/apple-flat-precomposed.png?1388527574",
    "bio" : "Show and tell for designers. This is Dribbble on Dribbble.",
    "location" : "Salem, MA",
    "links" : {
      "web" : "http://dribbble.com",
      "twitter" : "https://twitter.com/dribbble"
    },
    "type" : "Team",
    "created_at" : "2009-08-18T18:34:31Z",
    "updated_at" : "2014-02-14T22:32:11Z"
  },
  "low_profile" : false
}

Delete a shot

DELETE /shots/:id

Deleting a shot requires the user to be authenticated with the upload scope. The authenticated user must also own the shot.