Deprecation Notice
Api V3 is being deprecated on July 1st, 2023. Please consider updating to V5
Campaigns
A campaign is the event you create to fundraise for your favorite cause.
{
"id": 1,
"name": "My Awesome Campaign",
"slug": "my-awesome-campaign",
"url": "https://tiltify.com/@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"
}
}
Fields
| key | description |
|---|---|
| id integer |
This is the id of the 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 campaign. |
| slug string |
The url slug used to route to the campaign. These are unique for each user or team. |
| url string |
An absolute url that will take you to the campaign page. |
| description md-string |
The description of the campaign in markdown format. We support basic markdown functionality, so any common markdown should work. |
| avatar image |
An object representing the image for this campaign. It will fall back when appropriate to the FE / cause avatars if one is not present. It is safe to always render this avatar to represent the campaign. |
| supportable boolean |
Whether or not this campaign is supportable. |
| causeId integer |
A reference to the cause that this campaign supports. All campaigns support a cause. |
| fundraisingEventId integer |
A reference to the fundraising event if the campaign is raising money for a fundraising event. Will be null if it is not supporting a fundraising event. |
| originalFundraiserGoal float |
The original goal for the campaign if it has been changed. |
| fundraiserGoalAmount float |
The current goal for the campaign. |
| amountRaised float |
The amount of money raised by this campaign. |
| supportingAmountRaised float |
The amount of money raised by all supporting campaigns. This number is 0.0 for campaigns without supporters. |
| totalAmountRaised float |
The amount of money raised by this campaign and all supporting campaigns for this campaign. |
| startsAt date |
The date of when the campaign starts. (at midnight GMT) |
| endsAt date |
The date of when the campaign ends. (at midnight GMT) |
| livestream object |
An object representing the current livestream for this campaign |
| livestream.type string |
Can be one of the following: twitch,youtube,smashcast,mixer,mlg,image |
| livestream.channel string |
The channel for the livestream |