V5ApiPublic (1.0)
Download OpenAPI specification:Download
Welcome to the Tiltify V5 API docmentation site.
This is the public API for Tiltify. It is intended to be used by third party developers to build integrations with Tiltify. Additional documentation may be found at the Tiltify Developers documentation site.
The API uses the OpenAPI Specification (OAS) to define the API. More information about the OpenAPI Specification can be found at https://swagger.io/specification/.
Tiltify uses OAuth 2.0 access tokens to authenticate API requests. You may get an Application access_token
or a User access_token
.
To authenticate, you will need to create an application in the Tiltify User Dashboard, and use the generated credentials.
The method to get an application access token follows the Client Credentials Oauth2 grant flow.
You may give the required parameters to the Oauth Token Endpoint to get an access token for use with the api directly.
The method to get a user access token follows the OAuth2 Authorization Grant flow. The following is a specific example of how to retrieve A User Access token using OAuth2
Getting the code
This example will be using the following values as needed.
- Application ID: 1234
- Redirect https://www.example.com/redirect
- Secret Key: asdf
To begin with, send a user in a browser to the Tiltify OAuth Authorization url. Include your Client ID, and the response type of code
as query parameters.
You may include your redirect URI if you have more than one. A space separated list of scopes may also be added, however, if not included, the public
scope will be automatically selected.
https://v5api.tiltify.com/oauth/authorize?&client_id=1234&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com%2Fredirect&scope=public
After signing in and authorizing, the user will be redirected back to your chosen redirect URI with a query parameter of code
, containing the code used to fetch the access token.
https://www.example.com/redirect?code=1234abcdef
The code should be passed to your server backend as the following steps require your secret key, which should not be exposed to the public.
Converting The Code To A User Access Token
To retrieve the User Access Token, a post request must be made to the Token URL. In the body of the url are the following fields in Form Data format. Note specifically that code is the code retrieved from the first step.
client_id=1234
redirect_uri=https://www.example.com/redirect
code=1234abcdef
grant_type=authorization_code
Tiltify will return a response like the following:
{
"access_token": "ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5",
"created_at": "2023-01-27T19:32:03Z",
"expires_in": 7200,
"refresh_token": "njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3",
"scope": "public",
"token_type": "bearer"
}
This access token may now be used as shown below to make requests. When used with the /current-user endpoint, the full user
object is returned.
Add the Authorization header to your HTTP request.
Authorization: Bearer <access_token>
Example:
Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5
When an initial access token is created, a refresh token will be provided. The refresh token can be used to get a new access token when the current one expires. To do this, make a post request to the token url with grant_type set to refresh_token
.
Example:
To refresh the User Access Token, a post request must be made to the Token URL. In the body of the url are the following fields in Form Data or json format.
client_id=1234
client_secret=asdf
grant_type=refresh_token
refresh_token=njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3
Tiltify provides a dashboard to subscribe and test campaign and campaign donation webhooks.
To register a webhook, visit the Developer Dashboard
In order to begin registering webhooks, you must first create an application.
In the application dashboard, there will be a side navigation option for Webhooks
.
- Click the
Add Webhook
button - Create the webhook with an endpoint URL and an optional description.
- Click edit on the newly created webhook
- Click the
Events
submenu and add and event to subscribe to using theAdd event
button. - Enter your Campaign ID, this can be found in your campaign's dashboard under
Setup > Information
- Once created, click the
...
button and select Edit - Select the donation and/or Campaign events you would like to receive to your webhook endpoint and click
Update Event
. Including private data may include sensitive information, so please ensure that you secure your application.
You should now receive updates for those events on your webhook url.
Caution: When we send a webhook we expect the endpoint to respond with a 200-299 status code. If we do not receive that, we deactivate the webhook after about an hour.
Once a webhook is created, you may send test messages through the Testing
Submenu.
An example payload will be shown for each event type.
Click Send Test
to initiate the test.
Get auction house by user slug and auction house slug
Returns an auction house by its user slug and auction house slug
Authorizations:
path Parameters
user_slug required | string User slug |
auction_house_slug required | string Auction house slug |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "banner": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "campaign_id": "f6cc285f-19c6-4c34-a536-f012a00f4f64",
- "cause_id": "381ebca5-82cb-492f-a9ab-4df43b4a8ed4",
- "description": "My Awesome weekend auction house.",
- "fundraising_event_id": "8c768d4f-71d6-4e3f-8425-4f808b560cec",
- "id": "ed4aed6b-bfa7-4482-875e-310f55f9d7e4",
- "inserted_at": "2024-08-20T17:39:56.112728Z",
- "name": "My Awesome Auction House",
- "pledged_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "pledged_total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.112738Z",
- "retired_at": "2024-08-20T17:39:56.112742Z",
- "slug": "my-awesome-auction-house",
- "status": "published",
- "team_event_id": "2bfd7d3a-358c-4bc0-aa61-a2dbcce372b7",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.112749Z",
- "user_id": "a4bf5ac4-1535-456b-89c4-c43d32ebbcc4"
}
}
Get by ID
Returns a auction house by its ID
Authorizations:
path Parameters
auction_house_id required | string Auction House ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "banner": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "campaign_id": "f6cc285f-19c6-4c34-a536-f012a00f4f64",
- "cause_id": "381ebca5-82cb-492f-a9ab-4df43b4a8ed4",
- "description": "My Awesome weekend auction house.",
- "fundraising_event_id": "8c768d4f-71d6-4e3f-8425-4f808b560cec",
- "id": "ed4aed6b-bfa7-4482-875e-310f55f9d7e4",
- "inserted_at": "2024-08-20T17:39:56.112728Z",
- "name": "My Awesome Auction House",
- "pledged_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "pledged_total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.112738Z",
- "retired_at": "2024-08-20T17:39:56.112742Z",
- "slug": "my-awesome-auction-house",
- "status": "published",
- "team_event_id": "2bfd7d3a-358c-4bc0-aa61-a2dbcce372b7",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.112749Z",
- "user_id": "a4bf5ac4-1535-456b-89c4-c43d32ebbcc4"
}
}
List auction items
Authorizations:
path Parameters
auction_house_id required | string Auction House ID |
query Parameters
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only auction items that have been updated before the given moment in ISO8601 format |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only auction items that have been updated after the given moment in ISO8601 format |
updated_before | string Example: updated_before=2021-11-02T14:24:55.811924Z Returns only auction items that have been updated before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only auction items that have been updated after the given moment in ISO8601 format |
status | string Example: status=completed Status of the auction item. One of: active, or completed |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "activated_at": "2024-08-20T17:39:54.868648Z",
- "completed_at": "2024-08-20T17:39:54.868665Z",
- "description": "My Awesome weekend auction item.",
- "ends_at": "2024-08-20T17:39:54.868670Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "c6ed0b3e-5042-4527-8801-3cf42fb58a26",
- "images": [
- {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}
], - "inserted_at": "2024-08-20T17:39:56.195005Z",
- "legal": "This is a legal disclaimer.",
- "name": "My Awesome Auction Item",
- "rules": "To bid you must be in the USA.",
- "short_description": "short auction item.",
- "starting_bid": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-08-20T17:39:56.195022Z",
- "status": "active"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get auction house auction item by ID
Returns a auction item by its ID
Authorizations:
path Parameters
auction_house_id required | string Auction House ID |
auction_item_id required | string Auction Item ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "activated_at": "2024-08-20T17:39:54.868648Z",
- "completed_at": "2024-08-20T17:39:54.868665Z",
- "description": "My Awesome weekend auction item.",
- "ends_at": "2024-08-20T17:39:54.868670Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "c6ed0b3e-5042-4527-8801-3cf42fb58a26",
- "images": [
- {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}
], - "inserted_at": "2024-08-20T17:39:56.195005Z",
- "legal": "This is a legal disclaimer.",
- "name": "My Awesome Auction Item",
- "rules": "To bid you must be in the USA.",
- "short_description": "short auction item.",
- "starting_bid": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-08-20T17:39:56.195022Z",
- "status": "active"
}
}
List auction bids for an auction item
Authorizations:
path Parameters
auction_house_id required | string Auction House ID |
auction_item_id required | string Auction Item ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "auction_house_id": "17a73dcf-04a2-446f-a687-b304a5b5c0a5",
- "auction_item_id": "27a6726d-ddca-4deb-8d2b-f732abc3feca",
- "current_winner": false,
- "id": "727208b4-15b7-4890-8684-2a0ec61f9f40",
- "inserted_at": "2024-08-20T17:39:56.112349Z",
- "public_name": "John Doe",
- "removed_at": "2024-08-20T17:39:56.112367Z",
- "updated_at": "2024-08-20T17:39:56.112363Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get auction house by cause slug and auction house slug
Returns an auction house by its cause slug and auction house slug
Authorizations:
path Parameters
cause_slug required | string Caus slug |
auction_house_slug required | string Auction house slug |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "banner": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "campaign_id": "f6cc285f-19c6-4c34-a536-f012a00f4f64",
- "cause_id": "381ebca5-82cb-492f-a9ab-4df43b4a8ed4",
- "description": "My Awesome weekend auction house.",
- "fundraising_event_id": "8c768d4f-71d6-4e3f-8425-4f808b560cec",
- "id": "ed4aed6b-bfa7-4482-875e-310f55f9d7e4",
- "inserted_at": "2024-08-20T17:39:56.112728Z",
- "name": "My Awesome Auction House",
- "pledged_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "pledged_total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.112738Z",
- "retired_at": "2024-08-20T17:39:56.112742Z",
- "slug": "my-awesome-auction-house",
- "status": "published",
- "team_event_id": "2bfd7d3a-358c-4bc0-aa61-a2dbcce372b7",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.112749Z",
- "user_id": "a4bf5ac4-1535-456b-89c4-c43d32ebbcc4"
}
}
List schedules
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "description": null,
- "ends_at": "2024-08-20T17:39:54.554129Z",
- "id": "ae062d83-0113-47ec-bbbf-dd03144add4b",
- "inserted_at": "2024-08-20T17:39:54.554167Z",
- "legacy_id": 385765113,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-08-20T17:39:54.554183Z",
- "updated_at": "2024-08-20T17:39:54.554186Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fitness goals
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "current_value": "44.4",
- "distance_unit": "mile",
- "goal": "1000",
- "id": "3a44cc85-ca79-4308-bcf3-e03e9f78238b",
- "type": "Running"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get campaign by user slug and campaign slug
Returns a Campaign by its user slug and campaign slug
Authorizations:
path Parameters
user_slug required | string User Slug |
campaign_slug required | string Campaign Slug |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "cause_id": "a12f136c-6889-4d67-9a71-d814a5782fde",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "af540a9f-a0cb-4736-adbd-4376ce0c2144",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "25c34611-2e27-419f-abdf-e4b808902a74",
- "inserted_at": "2024-08-20T17:39:56.208617Z",
- "legacy_id": 114961315,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.208647Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.208651Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "id": "8e8467a1-89df-4aa5-8494-dde8095ef05f",
- "legacy_id": 827578882,
- "slug": "username",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "username": "UserName"
}, - "user_id": "c786dbff-c3bd-4c94-8e8c-3a01ce7e123e"
}
}
List polls
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "208ad895-a5fd-41ca-b2bd-ba68c96c5d27",
- "inserted_at": "2024-08-20T17:39:56.614796Z",
- "legacy_id": 135070663,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}
], - "updated_at": "2024-08-20T17:39:56.699325Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List targets
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "ends_at": "2024-08-20T17:39:56.717149Z",
- "id": "1b5fe581-cc8a-48bb-919b-1bb820eb2ead",
- "inserted_at": "2024-08-20T17:39:56.717185Z",
- "legacy_id": 797780918,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.717200Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get campaign poll by ID
Returns a poll by its ID
Authorizations:
path Parameters
poll_id required | string Poll ID |
campaign_id required | string Campaign ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "active": true,
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "208ad895-a5fd-41ca-b2bd-ba68c96c5d27",
- "inserted_at": "2024-08-20T17:39:56.614796Z",
- "legacy_id": 135070663,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}
], - "updated_at": "2024-08-20T17:39:56.699325Z"
}
}
List donations
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
completed_before | string Example: completed_before=2021-11-02T14:24:55.811924Z Returns only donations that have been completed before the given moment in ISO8601 format |
completed_after | string Example: completed_after=2021-11-02T14:24:55.811924Z Returns only donations that have been completed after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "9d8634fe-5bcb-4801-abe7-9ad8deece8b4",
- "cause_id": "4d96f099-3988-49d3-9ced-b8c3e3a694f7",
- "completed_at": "2024-08-20T17:39:56.283749Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "fundraising_event_id": "1b53101d-3e2c-4e54-a88e-3a78eec8ea77",
- "id": "e2c6e479-429b-4c65-9362-201682b82af2",
- "legacy_id": 558782876,
- "poll_id": "f2c14dc6-288f-45ff-9b53-eb61565f2c82",
- "poll_option_id": "a4573819-37bf-4587-aa13-a81f0e6d54e2",
- "reward_claims": [
- {
- "id": "2618a3a6-f550-468a-8a73-0ae6bf3da0db",
- "quantity": 1,
- "reward_id": "377ebb05-b7d5-4cd7-8e85-f73d8fe77034"
}
], - "reward_id": "533df566-7674-4356-8314-dc1128a73abd",
- "sustained": false,
- "target_id": "f1ef4895-25a6-42c4-a86e-b3763ad59d04",
- "team_event_id": "73b71bee-2c36-495b-ae00-219c36514d0b"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List donation matches
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only donation matches that have been updated before the given moment in ISO8601 format |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only donation matches that have been updated after the given moment in ISO8601 format |
updated_before | string Example: updated_before=2021-11-02T14:24:55.811924Z Returns only donation matches that have been updated before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only donation matches that have been updated after the given moment in ISO8601 format |
status | string Example: status=completed Status of the donation match. One of: active, or completed |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-01T21:57:26.389974Z",
- "donation_id": "5d73d797-554f-4064-975f-8bcdd9ab5976",
- "ends_at": "2024-10-01T21:57:26.389971Z",
- "id": "082b73c5-b2e0-4ac8-b2e1-d6e7e0b2cd05",
- "inserted_at": "2024-10-01T21:57:26.389946Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-01T21:57:26.389967Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-01T21:57:26.389963Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get by ID
Returns a campaign by its ID
Authorizations:
path Parameters
campaign_id required | string Campaign ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "cause_id": "a12f136c-6889-4d67-9a71-d814a5782fde",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "af540a9f-a0cb-4736-adbd-4376ce0c2144",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "25c34611-2e27-419f-abdf-e4b808902a74",
- "inserted_at": "2024-08-20T17:39:56.208617Z",
- "legacy_id": 114961315,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.208647Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.208651Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "id": "8e8467a1-89df-4aa5-8494-dde8095ef05f",
- "legacy_id": 827578882,
- "slug": "username",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "username": "UserName"
}, - "user_id": "c786dbff-c3bd-4c94-8e8c-3a01ce7e123e"
}
}
List rewards
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "description": "The streamer will pick a song and sing it poorly",
- "ends_at": "2024-08-20T17:39:56.632653Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "b9ff05d1-304e-4488-a1c9-e269c88e1a1f",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-08-20T17:39:56.632684Z",
- "legacy_id": 459116384,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-08-20T17:39:56.632698Z",
- "updated_at": "2024-08-20T17:39:56.632702Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List milestones
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
include_disabled | boolean Example: include_disabled=true Returns disabled milestones. Defaults to false |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated before the given moment in ISO8601 format |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated after the given moment in ISO8601 format |
updated_before | string Example: updated_before=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "73004618-b4ed-41d7-b4df-a351e11a4f1b",
- "inserted_at": "2024-08-20T17:39:56.547601Z",
- "legacy_id": 228115454,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.547628Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top donors
Authorizations:
path Parameters
campaign_id required | string Campaign ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top teams
Authorizations:
path Parameters
cause_id required | string Cause ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fundraising events
Authorizations:
path Parameters
cause_id required | string Cause ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "can_publish_supporting_at": "2024-08-20T17:39:55.923732Z",
- "cause_id": "7109ab96-da2f-47ba-a520-969d75667fee",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2024-08-20T17:39:55.923728Z",
- "ends_at": "2024-08-20",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "5a1d1dc4-19bf-4656-8329-9bff907a160c",
- "inserted_at": "2024-08-20T17:39:55.923679Z",
- "legacy_id": 202876099,
- "name": "Spooktober 2022",
- "published_at": "2024-08-20T17:39:55.923708Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2024-08-20T17:39:55.923724Z",
- "starts_at": "2024-08-20",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:55.923740Z",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top donors
Authorizations:
path Parameters
cause_id required | string Cause ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top fundraisers
Authorizations:
path Parameters
cause_id required | string Cause ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get by ID
Returns a cause by its ID
Authorizations:
path Parameters
cause_id required | string Cause ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "contact": {
- "address_line1": "22251 Bahringer Turnpike",
- "address_line2": null,
- "city": "Bright Tree Village",
- "country": "Outer Rim",
- "email": "contact@erf.test",
- "postal_code": "20001",
- "region": "Endor"
}, - "currency_code": "USD",
- "description": "Ewok Rescue Foundation (ERF) works around the forest moon of Endor to promote the most effective Ewok protection. Join us and help us to build a better Endor!",
- "government_id": "12-3456789",
- "id": "a4b21246-6e1a-4190-bd1d-f4aec541cd44",
- "inserted_at": "2024-08-20T17:39:55.766703Z",
- "legacy_id": 89857388,
- "name": "Ewok Rescue Foundation",
- "short_description": "ERF works in Endor to protect the Ewoks",
- "slug": "ewok-rescue-foundation",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "updated_at": "2024-08-20T17:39:55.766732Z"
}
}
List top teams
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top fundraisers
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top teams fitness times
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top users fitness distances
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top users fitness times
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top donors
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaigns
Returns supporting campaigns by Fundraising Event ID
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising event ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "cause_id": "a12f136c-6889-4d67-9a71-d814a5782fde",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "af540a9f-a0cb-4736-adbd-4376ce0c2144",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "25c34611-2e27-419f-abdf-e4b808902a74",
- "inserted_at": "2024-08-20T17:39:56.208617Z",
- "legacy_id": 114961315,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.208647Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.208651Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "id": "8e8467a1-89df-4aa5-8494-dde8095ef05f",
- "legacy_id": 827578882,
- "slug": "username",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "username": "UserName"
}, - "user_id": "c786dbff-c3bd-4c94-8e8c-3a01ce7e123e"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get by ID
Returns a fundraising event by its ID
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "can_publish_supporting_at": "2024-08-20T17:39:55.923732Z",
- "cause_id": "7109ab96-da2f-47ba-a520-969d75667fee",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2024-08-20T17:39:55.923728Z",
- "ends_at": "2024-08-20",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "5a1d1dc4-19bf-4656-8329-9bff907a160c",
- "inserted_at": "2024-08-20T17:39:55.923679Z",
- "legacy_id": 202876099,
- "name": "Spooktober 2022",
- "published_at": "2024-08-20T17:39:55.923708Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2024-08-20T17:39:55.923724Z",
- "starts_at": "2024-08-20",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:55.923740Z",
}
}
List top teams fitness distances
Authorizations:
path Parameters
fundraising_event_id required | string Fundraising Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" "custom" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fitness goals
Authorizations:
path Parameters
fundraising_event_id required | string FundraisingEvent ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "current_value": "44.4",
- "distance_unit": "mile",
- "goal": "1000",
- "id": "3a44cc85-ca79-4308-bcf3-e03e9f78238b",
- "type": "Running"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List donations Deprecated
This endpoint will list donations for a given Fundraising Event. Contact support for access to this endpoint.
Authorizations:
path Parameters
fundraising_event_id required | string FundraisingEvent ID or legacy ID |
query Parameters
completed_before | string Example: completed_before=2021-11-02T14:24:55.811924Z Returns only donations that have been completed before the given moment in ISO8601 format |
completed_after | string Example: completed_after=2021-11-02T14:24:55.811924Z Returns only donations that have been completed after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "9d8634fe-5bcb-4801-abe7-9ad8deece8b4",
- "cause_id": "4d96f099-3988-49d3-9ced-b8c3e3a694f7",
- "completed_at": "2024-08-20T17:39:56.283749Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "fundraising_event_id": "1b53101d-3e2c-4e54-a88e-3a78eec8ea77",
- "id": "e2c6e479-429b-4c65-9362-201682b82af2",
- "legacy_id": 558782876,
- "poll_id": "f2c14dc6-288f-45ff-9b53-eb61565f2c82",
- "poll_option_id": "a4573819-37bf-4587-aa13-a81f0e6d54e2",
- "reward_claims": [
- {
- "id": "2618a3a6-f550-468a-8a73-0ae6bf3da0db",
- "quantity": 1,
- "reward_id": "377ebb05-b7d5-4cd7-8e85-f73d8fe77034"
}
], - "reward_id": "533df566-7674-4356-8314-dc1128a73abd",
- "sustained": false,
- "target_id": "f1ef4895-25a6-42c4-a86e-b3763ad59d04",
- "team_event_id": "73b71bee-2c36-495b-ae00-219c36514d0b"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Token
Returns an access and refresh token with a provided client id, secret, and grant type. Tokens expire in 7200
seconds.
Authorizations:
query Parameters
client_id required | string Client Id |
client_secret required | string Client Secret |
grant_type required | string Default: "client_credentials" Enum: "client_credentials" "authorization_code" "refresh_token" Grant Type |
code | string Authorization Code; |
refresh_token | string Refresh Token; |
scope | string Default: "public" Value: "public" Scope |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "access_token": "ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5",
- "created_at": "2023-01-27T19:32:03Z",
- "expires_in": 7200,
- "refresh_token": "njjjytm3otetmgrjmi00yjawlwe4zgytzjixy2mzm2y3njawcg121231999393a3",
- "scope": "public",
- "token_type": "bearer"
}
Authorize
Returns a code
through the applications redirect_uri
to be used with the /token
with the authorization_code
grant.
Authorizations:
query Parameters
client_id required | string Client Id |
redirect_uri required | string Redirect URI |
response_type required | string Value: "code" Response Type |
scope | string Default: "public" Value: "public" Scope |
List milestones
Authorizations:
path Parameters
personal_campaign_id required | string Campaign ID |
query Parameters
include_disabled | boolean Example: include_disabled=true Returns disabled milestones. Defaults to false |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated before the given moment in ISO8601 format |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated after the given moment in ISO8601 format |
updated_before | string Example: updated_before=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "73004618-b4ed-41d7-b4df-a351e11a4f1b",
- "inserted_at": "2024-08-20T17:39:56.547601Z",
- "legacy_id": 228115454,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.547628Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List rewards
Authorizations:
path Parameters
personal_campaign_id required | string Campaign ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "description": "The streamer will pick a song and sing it poorly",
- "ends_at": "2024-08-20T17:39:56.632653Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "b9ff05d1-304e-4488-a1c9-e269c88e1a1f",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-08-20T17:39:56.632684Z",
- "legacy_id": 459116384,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-08-20T17:39:56.632698Z",
- "updated_at": "2024-08-20T17:39:56.632702Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get campaign poll by ID
Returns a poll by its ID
Authorizations:
path Parameters
poll_id required | string Poll ID |
personal_campaign_id required | string Campaign ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "active": true,
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "208ad895-a5fd-41ca-b2bd-ba68c96c5d27",
- "inserted_at": "2024-08-20T17:39:56.614796Z",
- "legacy_id": 135070663,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}
], - "updated_at": "2024-08-20T17:39:56.699325Z"
}
}
Get by ID
Returns a personal campaign by its ID
Authorizations:
path Parameters
personal_campaign_id required | string Personal Campaign ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "My Awesome weekend campaign.",
- "fundraising_for_name": "ME!",
- "fundraising_for_self": true,
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "0368bdc3-6a3b-4c33-adca-5be154a10d80",
- "inserted_at": "2024-10-01T21:57:26.572571Z",
- "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-10-01T21:57:26.572587Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-01T21:57:26.572591Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "id": "8e8467a1-89df-4aa5-8494-dde8095ef05f",
- "legacy_id": 827578882,
- "slug": "username",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "username": "UserName"
}, - "user_id": "71384ab5-9316-4b9e-9492-9c46ef27d2a2"
}
}
List gifts
Authorizations:
path Parameters
personal_campaign_id required | string Campaign ID |
query Parameters
completed_before | string Example: completed_before=2021-11-02T14:24:55.811924Z Returns only donations that have been completed before the given moment in ISO8601 format |
completed_after | string Example: completed_after=2021-11-02T14:24:55.811924Z Returns only donations that have been completed after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-01T21:57:26.366438Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "gift_matches": [ ],
- "id": "384751df-783f-4df6-a182-fcfd7ff1f8a9",
- "is_match": false,
- "personal_campaign_id": "6e7f720f-b43a-4a72-9ff7-c93d7f6353ef",
- "poll_id": "5236bb0b-f163-4085-a9b3-abf3b0709888",
- "poll_option_id": "f299df0b-129a-45f7-b319-365099d67a4f",
- "reward_claims": [
- {
- "id": "29e42f58-53eb-46fd-bdb5-8bf67870c833",
- "quantity": 1,
- "reward_id": "410737e8-5897-4746-9370-15ecf84ccfb4"
}
], - "target_id": "f462df26-6324-4f9e-a161-b9e4ced7d5aa"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List schedules
Authorizations:
path Parameters
personal_campaign_id required | string Campaign ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "description": null,
- "ends_at": "2024-08-20T17:39:54.554129Z",
- "id": "ae062d83-0113-47ec-bbbf-dd03144add4b",
- "inserted_at": "2024-08-20T17:39:54.554167Z",
- "legacy_id": 385765113,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-08-20T17:39:54.554183Z",
- "updated_at": "2024-08-20T17:39:54.554186Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List polls
Authorizations:
path Parameters
personal_campaign_id required | string Campaign ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "208ad895-a5fd-41ca-b2bd-ba68c96c5d27",
- "inserted_at": "2024-08-20T17:39:56.614796Z",
- "legacy_id": 135070663,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}
], - "updated_at": "2024-08-20T17:39:56.699325Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List targets
Authorizations:
path Parameters
personal_campaign_id required | string Campaign ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "ends_at": "2024-08-20T17:39:56.717149Z",
- "id": "1b5fe581-cc8a-48bb-919b-1bb820eb2ead",
- "inserted_at": "2024-08-20T17:39:56.717185Z",
- "legacy_id": 797780918,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.717200Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get by ID
Returns a team by its ID
Authorizations:
path Parameters
team_id required | string Team ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Awesome group of friends fundraising for charity together.",
- "id": "acf65752-35c8-4951-87af-5834cffa0231",
- "legacy_id": 536666288,
- "name": "Awesome Team",
- "slug": "awesome-team",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
},
}
}
List team members
Authorizations:
path Parameters
team_id required | string Team ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "id": "8d9b860f-4836-488c-84e5-6bc1035acd3b",
- "inserted_at": "2024-08-20T17:39:54.504990Z",
- "legacy_id": 493913625,
- "roles": [
- {
- "id": "daf58656-fc83-4946-9cbf-a6889b17f2cc",
- "key": "team_super_admin",
- "name": "Team Administrator"
}
], - "updated_at": "2024-08-20T17:39:55.658066Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "id": "8e8467a1-89df-4aa5-8494-dde8095ef05f",
- "legacy_id": 827578882,
- "slug": "username",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "username": "UserName"
}
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List Team Campaigns
Authorizations:
path Parameters
team_id required | string Team ID |
query Parameters
status | string Enum: "published" "retired" Example: status=published Use this parameter to filter campaigns by the given status. |
supporting_type | string Enum: "invite_only" "none" "private" "public" Example: supporting_type=public Use this parameter to filter campaigns by the given supporting type. |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only campaigns that have been updated after the given moment in ISO8601 format |
updated_before | string Example: updated_before=2021-11-02T14:24:55.811924Z Returns only campaigns that have been updated before the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "currency_code": "USD",
- "description": "Let's fundraise togehter",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "9e521508-d0fe-407f-abcd-3a8c10b07d2d",
- "inserted_at": "2024-08-20T17:39:56.787358Z",
- "legacy_id": 541985915,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.787386Z",
- "retired_at": null,
- "slug": "our-awesome-team-campaign",
- "status": "published",
- "supportable": "none",
- "supporting_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "team": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Awesome group of friends fundraising for charity together.",
- "id": "acf65752-35c8-4951-87af-5834cffa0231",
- "legacy_id": 536666288,
- "name": "Awesome Team",
- "slug": "awesome-team",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
},
}, - "team_id": "42bd01de-aa95-4e8d-a4f8-16ecd66f64ac",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.787394Z",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get by slug
Returns a team by its slug
Authorizations:
path Parameters
slug required | string Team slug |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Awesome group of friends fundraising for charity together.",
- "id": "acf65752-35c8-4951-87af-5834cffa0231",
- "legacy_id": 536666288,
- "name": "Awesome Team",
- "slug": "awesome-team",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
},
}
}
List targets
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "ends_at": "2024-08-20T17:39:56.717149Z",
- "id": "1b5fe581-cc8a-48bb-919b-1bb820eb2ead",
- "inserted_at": "2024-08-20T17:39:56.717185Z",
- "legacy_id": 797780918,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.717200Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List polls
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "208ad895-a5fd-41ca-b2bd-ba68c96c5d27",
- "inserted_at": "2024-08-20T17:39:56.614796Z",
- "legacy_id": 135070663,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}
], - "updated_at": "2024-08-20T17:39:56.699325Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List donations
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID or legacy ID |
query Parameters
completed_before | string Example: completed_before=2021-11-02T14:24:55.811924Z Returns only donations that have been completed before the given moment in ISO8601 format |
completed_after | string Example: completed_after=2021-11-02T14:24:55.811924Z Returns only donations that have been completed after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "9d8634fe-5bcb-4801-abe7-9ad8deece8b4",
- "cause_id": "4d96f099-3988-49d3-9ced-b8c3e3a694f7",
- "completed_at": "2024-08-20T17:39:56.283749Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "fundraising_event_id": "1b53101d-3e2c-4e54-a88e-3a78eec8ea77",
- "id": "e2c6e479-429b-4c65-9362-201682b82af2",
- "legacy_id": 558782876,
- "poll_id": "f2c14dc6-288f-45ff-9b53-eb61565f2c82",
- "poll_option_id": "a4573819-37bf-4587-aa13-a81f0e6d54e2",
- "reward_claims": [
- {
- "id": "2618a3a6-f550-468a-8a73-0ae6bf3da0db",
- "quantity": 1,
- "reward_id": "377ebb05-b7d5-4cd7-8e85-f73d8fe77034"
}
], - "reward_id": "533df566-7674-4356-8314-dc1128a73abd",
- "sustained": false,
- "target_id": "f1ef4895-25a6-42c4-a86e-b3763ad59d04",
- "team_event_id": "73b71bee-2c36-495b-ae00-219c36514d0b"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List schedules
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "description": null,
- "ends_at": "2024-08-20T17:39:54.554129Z",
- "id": "ae062d83-0113-47ec-bbbf-dd03144add4b",
- "inserted_at": "2024-08-20T17:39:54.554167Z",
- "legacy_id": 385765113,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-08-20T17:39:54.554183Z",
- "updated_at": "2024-08-20T17:39:54.554186Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get by ID
Returns a Team Campaign by its ID
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "currency_code": "USD",
- "description": "Let's fundraise togehter",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "9e521508-d0fe-407f-abcd-3a8c10b07d2d",
- "inserted_at": "2024-08-20T17:39:56.787358Z",
- "legacy_id": 541985915,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-08-20T17:39:56.787386Z",
- "retired_at": null,
- "slug": "our-awesome-team-campaign",
- "status": "published",
- "supportable": "none",
- "supporting_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "team": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Awesome group of friends fundraising for charity together.",
- "id": "acf65752-35c8-4951-87af-5834cffa0231",
- "legacy_id": 536666288,
- "name": "Awesome Team",
- "slug": "awesome-team",
- "social": {
- "facebook": "tiltify",
- "instagram": "tiltify",
- "snapchat": "tiltify",
- "tiktok": "tilitfy",
- "twitch": "tilitfy",
- "twitter": "tiltify",
- "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw"
}, - "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
},
}, - "team_id": "42bd01de-aa95-4e8d-a4f8-16ecd66f64ac",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-08-20T17:39:56.787394Z",
}
}
List milestones
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID or legacy ID |
query Parameters
include_disabled | boolean Example: include_disabled=true Returns disabled milestones. Defaults to false |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated before the given moment in ISO8601 format |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated after the given moment in ISO8601 format |
updated_before | string Example: updated_before=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only milestones that have been updated after the given moment in ISO8601 format |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "73004618-b4ed-41d7-b4df-a351e11a4f1b",
- "inserted_at": "2024-08-20T17:39:56.547601Z",
- "legacy_id": 228115454,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.547628Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top fundraisers
Authorizations:
path Parameters
team_campaign_id required | string Team Event ID |
query Parameters
time_type | string Enum: "daily" "weekly" "monthly" "yearly" "ytd" "all" Example: time_type=all The time range to use in leaderboard generation |
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 403
- 404
- 422
{- "data": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "heat": null,
- "id": "fe07a157-ee6c-4f14-9944-78e62dac766b",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fitness goals
Authorizations:
path Parameters
team_campaign_id required | string TeamCampaign ID or legacy ID |
query Parameters
after | string Returns records after the given cursor |
before | string Returns records before the given cursor |
limit | integer [ 1 .. 100 ] Default: 10 |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": [
- {
- "current_value": "44.4",
- "distance_unit": "mile",
- "goal": "1000",
- "id": "3a44cc85-ca79-4308-bcf3-e03e9f78238b",
- "type": "Running"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get team campaign poll by ID
Returns a poll by its ID
Authorizations:
path Parameters
poll_id required | string Poll ID |
team_campaign_id required | string Team Campaign ID or legacy ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "active": true,
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "208ad895-a5fd-41ca-b2bd-ba68c96c5d27",
- "inserted_at": "2024-08-20T17:39:56.614796Z",
- "legacy_id": 135070663,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "eb211ac8-6661-426d-b32b-671531eca9dc",
- "inserted_at": "2024-08-20T17:39:56.618850Z",
- "legacy_id": 193590929,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-08-20T17:39:56.618869Z"
}
], - "updated_at": "2024-08-20T17:39:56.699325Z"
}
}