Deprecation Notice

Api V3 is being deprecated on July 1st, 2023. Please consider updating to V5

V5 Api Documentation

GET /campaigns/:id

Retrieves a single campaign given an identifier.

{
  "meta": {
    "status": 200
  },
  "data": {
    "id": 1,
    "name": "My Awesome Campaign",
    "slug": "my-awesome-campaign",
    "url": "/@username/my-awesome-campaign",
    "startsAt": 1493355600000,
    "endsAt": 1496206800000,
    "description": "My awesome weekend campaign.",
    "avatar": {
      "src": "https://asdf.cloudfront.net/asdf.jpg",
      "alt": "",
      "width": 200,
      "height": 200
    },
    "causeId": 17,
    "fundraisingEventId": 39,
    "fundraiserGoalAmount": 10000,
    "originalGoalAmount": 5000,
    "amountRaised": 3402.00,
    "supportingAmountRaised": 8923.00,
    "totalAmountRaised": 12325.00,
    "supportable": true,
    "status": "published",
    "user": {
      "id": 1,
      "username": "UserName",
      "slug": "username",
      "url": "/@username",
      "avatar": {
        "src": "https://asdf.cloudfront.net/asdf.jpg",
        "alt": "",
        "width": 200,
        "height": 200
      }
    },
    "team": {
      "id": 1,
      "username": "Team Name",
      "slug": "teamslug",
      "url": "/+teamslug",
      "avatar": {
        "src": "https://asdf.cloudfront.net/asdf.jpg",
        "alt": "",
        "width": 200,
        "height": 200
      }
    },
    "livestream": {
      "type": "twitch",
      "channel": "tiltify"
    }
  }
}

Examples

curl https://tiltify.com/api/v3/campaigns/42