Deprecation Notice

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

V5 Api Documentation


Fundraising Event

A fundraising event is an event organized by a cause with schedules and incentives.

{
  "id": 1,
  "name": "Big Event 2017",
  "slug": "big-event-2017",
  "url": "https://tiltify.com/cause-slug/big-event-2017",
  "description": "Play For More Than Bragging Rights\r\n\r\nSign up to create your own campaign and start fundraising. Play and stream your favorite video games to raise donations and unlock exclusive loot.\r\n\r\nSt. Jude has helped push the childhood cancer survival rate from less than 20% when we opened to 80% today. We won’t stop until no child dies from cancer.",
  "video": {
    "src": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "alt": "synthesize distributed solutions",
    "width": 640,
    "height": 360
  },
  "image": {
    "src": "https://asdf.cloudfront.net/asdf.jpg",
    "alt": "synthesize distributed solutions",
    "width": 640,
    "height": 360
  },
  "avatar": {
    "src": "https://asdf.cloudfront.net/asdf.jpg",
    "alt": "synthesize distributed solutions",
    "width": 64,
    "height": 64
  },
  "logo": {
    "src": "https://asdf.cloudfront.net/asdf.jpg",
    "alt": "synthesize distributed solutions",
    "width": 64,
    "height": 100
  },
  "banner": {
    "src": "https://asdf.cloudfront.net/asdf.jpg",
    "alt": "synthesize distributed solutions",
    "width": 530,
    "height": 1440
  },
  "bannerTitle": "St. Jude PLAY LIVE",
  "bannerIntro": "Play video games and create a fundraising campaign to help kids battling cancer.",
  "currency": "USD",
  "goal": 10000,
  "amountRaised": 8923,
  "startsOn": "2017-03-24",
  "endsOn": "2017-03-26"
  "causeId": 17,
}

Fields

key description
id
integer
This is the id of the fundraising event. It is a unique identifier that can be used to always find the event. It will never change.
name
string
The name of the fundraising event.
slug
string
The url slug used to route to the fundraising event. These are unique for each cause
url
string
An absolute url that will take you to the fundraiisng event page.
description
md-string
The description of the fundraising event in markdown format.
video
string
The absolute url of a video the fundraising event uses in its about section.
image
string
The absolute url of an image or video fallback the fundraising event uses in its about section.
logo
string
The absolute url of an image used as the logo for the fundraising event.
avatar
string
The absolute url of an image used as the avatar for this fundraising event.
currency
string
The currency code to describe all amount of money under this campaign. This is an ISO 4217 currency code.
goal
float
The current goal for the fundraising event.
amountRaised
float
The amount of money raised by this fundraising event.
startsOn
date
The date of when the campaign starts. An ISO 8601 formatted date.
endsOn
date
The date of when the campaign ends. An ISO 8601 formatted date.
causeId
integer
A reference to the cause that this fundraising event is for.

results matching ""

    No results matching ""