V5ApiCause (1.0)
Download OpenAPI specification:Download
List campaign schedules by campaign ID
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-01-02T17:56:41.604289Z",
- "id": "bb62f570-5a88-41d4-94ea-002ff29798f3",
- "inserted_at": "2024-01-02T17:56:41.604332Z",
- "legacy_id": 265553902,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-01-02T17:56:41.604354Z",
- "updated_at": "2024-01-02T17:56:41.604359Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List donation matches
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"
}, - "completed_at": "2024-01-02T17:56:40.477210Z",
- "donation_id": "46923d7e-0bd8-47ad-a7cb-7e951f6bf591",
- "ends_at": "2024-01-02T17:56:40.477190Z",
- "id": "c3f20f0a-00b5-41c5-a23c-2165e9ff17a8",
- "inserted_at": "2024-01-02T17:56:40.477166Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-01-02T17:56:40.477187Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.477183Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaign rewards by campaign ID
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-01-02T17:56:41.336934Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "8be36e56-a6db-418b-8ed1-d70576df5bff",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-01-02T17:56:41.336977Z",
- "legacy_id": 424537660,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-01-02T17:56:41.337008Z",
- "updated_at": "2024-01-02T17:56:41.337012Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaign targets by campaign ID
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-01-02T17:56:41.683941Z",
- "id": "d85e9039-6245-4f9b-a2c9-ebe8bcde561a",
- "inserted_at": "2024-01-02T17:56:41.683985Z",
- "legacy_id": 233573389,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.684007Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaigns
Lists the current cause campaigns
Authorizations:
query Parameters
status | string Enum: "published" "retired" "unpublished" 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 |
user_id | string Example: user_id=314a5932-1ea2-42d4-9a9c-f2047411c155 Filter the given campaigns by a user id or legacy id |
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": "ceb42ca9-b389-499b-9175-9cbcc788445d",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "a4a140b1-f108-4442-ac72-2b167fffabf0",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "7cb1eaf4-9196-48ef-8143-f3d03459ac05",
- "inserted_at": "2024-01-02T17:56:40.215567Z",
- "legacy_id": 955494543,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:40.215601Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.215605Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "email": "fundraiser@tiltify.test",
- "id": "9fb818e4-d68a-4d71-a2d0-2ba3ca81248b",
- "legacy_id": 392068014,
- "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": "dd36bfe8-d033-4fc5-b0b5-f4da5797f457"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get campaign 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": "ceb42ca9-b389-499b-9175-9cbcc788445d",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "a4a140b1-f108-4442-ac72-2b167fffabf0",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "7cb1eaf4-9196-48ef-8143-f3d03459ac05",
- "inserted_at": "2024-01-02T17:56:40.215567Z",
- "legacy_id": 955494543,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:40.215601Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.215605Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "email": "fundraiser@tiltify.test",
- "id": "9fb818e4-d68a-4d71-a2d0-2ba3ca81248b",
- "legacy_id": 392068014,
- "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": "dd36bfe8-d033-4fc5-b0b5-f4da5797f457"
}
}
List top donors by campaign ID
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaign donations by campaign ID
Authorizations:
path Parameters
campaign_id required | string Campaign ID or legacy ID |
query Parameters
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 |
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 |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only campaigns that have been created after the given moment in ISO8601 format |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only campaigns that have been created before the given moment in ISO8601 format |
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": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "af7805b8-1c71-4c8f-8cf6-a3fc0b145224",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "91cdad68-efc3-4edc-8fd1-257e6ceb4257",
- "charity_can_contact": false,
- "completed_at": "2024-01-02T17:56:40.399459Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "b7f02b77-f313-49a8-b990-c31918bfc6bc",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "8281549e-1456-4423-b039-99a1e304b690",
- "legacy_id": 970414429,
- "moderated_at": "2024-01-02T17:56:40.660962Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "e130d834-aeb4-4d11-b6dd-64e670c379d7",
- "poll_option_id": "097f293a-ad0c-48cc-bd95-f2b626de6553",
- "reward_claims": [
- {
- "id": "f9aee7cd-5ec3-4dce-8587-cf5950665c9c",
- "quantity": 1,
- "reward_id": "a5a0bdd7-890d-490f-a072-66d1384e6770"
}
], - "reward_id": "213a07dd-f5ed-4baf-8ca9-f7a78355bfbe",
- "sustained": false,
- "target_id": "78863f0d-9511-4620-a397-177dcbe4f80a",
- "team_event_id": "f5928524-ede5-43e0-85ac-ba15e2263a49",
- "team_event_name": "Awesome Test Team Event"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaign polls by campaign ID
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": "6057ef02-aa5c-40bb-9f38-97cb5413462a",
- "inserted_at": "2024-01-02T17:56:41.196033Z",
- "legacy_id": 820360970,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "1b2bd4ed-2222-4335-80a3-c78394d7f04d",
- "inserted_at": "2024-01-02T17:56:41.232656Z",
- "legacy_id": 546575664,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.232690Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "1b2bd4ed-2222-4335-80a3-c78394d7f04d",
- "inserted_at": "2024-01-02T17:56:41.232656Z",
- "legacy_id": 546575664,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.232690Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "1b2bd4ed-2222-4335-80a3-c78394d7f04d",
- "inserted_at": "2024-01-02T17:56:41.232656Z",
- "legacy_id": 546575664,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.232690Z"
}
], - "updated_at": "2024-01-02T17:56:41.316394Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaign milestones by campaign ID
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": "7ad1baeb-aab0-4e99-a1aa-dad1afbd6380",
- "inserted_at": "2024-01-02T17:56:41.112031Z",
- "legacy_id": 120875312,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.112071Z"
}
], - "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": "ceb42ca9-b389-499b-9175-9cbcc788445d",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "a4a140b1-f108-4442-ac72-2b167fffabf0",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "7cb1eaf4-9196-48ef-8143-f3d03459ac05",
- "inserted_at": "2024-01-02T17:56:40.215567Z",
- "legacy_id": 955494543,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:40.215601Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.215605Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "email": "fundraiser@tiltify.test",
- "id": "9fb818e4-d68a-4d71-a2d0-2ba3ca81248b",
- "legacy_id": 392068014,
- "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": "dd36bfe8-d033-4fc5-b0b5-f4da5797f457"
}
}
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: "cause" Enum: "public" "cause" 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": "cause",
- "token_type": "bearer"
}
List fundraising_event donations by fundraising_event ID
Authorizations:
path Parameters
fundraising_event_id required | string FundraisingEvent ID or legacy ID |
query Parameters
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 |
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 |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only donations that have been created after the given moment in ISO8601 format |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only donations that have been created before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only donations 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 donations 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": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "af7805b8-1c71-4c8f-8cf6-a3fc0b145224",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "91cdad68-efc3-4edc-8fd1-257e6ceb4257",
- "charity_can_contact": false,
- "completed_at": "2024-01-02T17:56:40.399459Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "b7f02b77-f313-49a8-b990-c31918bfc6bc",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "8281549e-1456-4423-b039-99a1e304b690",
- "legacy_id": 970414429,
- "moderated_at": "2024-01-02T17:56:40.660962Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "e130d834-aeb4-4d11-b6dd-64e670c379d7",
- "poll_option_id": "097f293a-ad0c-48cc-bd95-f2b626de6553",
- "reward_claims": [
- {
- "id": "f9aee7cd-5ec3-4dce-8587-cf5950665c9c",
- "quantity": 1,
- "reward_id": "a5a0bdd7-890d-490f-a072-66d1384e6770"
}
], - "reward_id": "213a07dd-f5ed-4baf-8ca9-f7a78355bfbe",
- "sustained": false,
- "target_id": "78863f0d-9511-4620-a397-177dcbe4f80a",
- "team_event_id": "f5928524-ede5-43e0-85ac-ba15e2263a49",
- "team_event_name": "Awesome Test Team Event"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fundraising_event rewards by fundraising_event ID
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": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "description": "The streamer will pick a song and sing it poorly",
- "ends_at": "2024-01-02T17:56:41.336934Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "8be36e56-a6db-418b-8ed1-d70576df5bff",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-01-02T17:56:41.336977Z",
- "legacy_id": 424537660,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-01-02T17:56:41.337008Z",
- "updated_at": "2024-01-02T17:56:41.337012Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top teams fitness distances by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top fundraisers by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top users fitness times by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fundraising_event registrations by fundraising_event ID
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": [
- {
- "id": "f613252b-2339-4725-9996-35fa7fc85497",
- "inserted_at": "2024-01-02T17:56:38.831168Z",
- "updated_at": "2024-01-02T17:56:38.831185Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top teams fitness times by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fundraising_event incentives by fundraising_event ID
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": [
- {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "description": null,
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "9b793301-8492-4e36-b033-f8cfc4986438",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-01-02T17:56:40.792365Z",
- "is_milestone": true,
- "legacy_id": 142341121,
- "name": "Holiday Special Livestream",
- "updated_at": "2024-01-02T17:56:40.796404Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top donors by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top teams by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top users fitness distances by fundraising_event_id
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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get Fundraising Event 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-01-02T17:56:40.750370Z",
- "cause_id": "655c498c-5cfe-4fad-b52c-1aaf008d7f38",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2024-01-02T17:56:40.750367Z",
- "ends_at": "2024-01-02",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ba90d7a6-452c-4421-867e-6fb701f2dcb3",
- "inserted_at": "2024-01-02T17:56:40.750334Z",
- "legacy_id": 402596137,
- "name": "Spooktober 2022",
- "published_at": "2024-01-02T17:56:40.750359Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2024-01-02T17:56:40.750363Z",
- "starts_at": "2024-01-02",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.750375Z",
}
}
List fundraising event supporting events
Authorizations:
path Parameters
fundraising_event_id required | string FundraisingEvent ID or legacy ID |
query Parameters
status | string Enum: "published" "retired" "unpublished" Example: status=published Use this parameter to filter events by the given status. |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only events 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 events 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
}, - "cause_id": "ceb42ca9-b389-499b-9175-9cbcc788445d",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "a4a140b1-f108-4442-ac72-2b167fffabf0",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "7cb1eaf4-9196-48ef-8143-f3d03459ac05",
- "inserted_at": "2024-01-02T17:56:40.215567Z",
- "legacy_id": 955494543,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:40.215601Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.215605Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "email": "fundraiser@tiltify.test",
- "id": "9fb818e4-d68a-4d71-a2d0-2ba3ca81248b",
- "legacy_id": 392068014,
- "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": "dd36bfe8-d033-4fc5-b0b5-f4da5797f457"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List fundraising_events
Lists the current cause fundraising_events
Authorizations:
query Parameters
starts_after | string Example: starts_after=2021-11-02T14:24:55.811924Z Returns only fundraising_events that have been starts after the given moment in ISO8601 format |
starts_before | string Example: starts_before=2021-11-02T14:24:55.811924Z Returns only fundraising_events that have been starts before the given moment in ISO8601 format |
status | string Enum: "published" "retired" "unpublished" Example: status=published Use this parameter to filter fundraising_events by the given status. |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only fundraising_events 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 fundraising_events 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": [
- {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "can_publish_supporting_at": "2024-01-02T17:56:40.750370Z",
- "cause_id": "655c498c-5cfe-4fad-b52c-1aaf008d7f38",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2024-01-02T17:56:40.750367Z",
- "ends_at": "2024-01-02",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ba90d7a6-452c-4421-867e-6fb701f2dcb3",
- "inserted_at": "2024-01-02T17:56:40.750334Z",
- "legacy_id": 402596137,
- "name": "Spooktober 2022",
- "published_at": "2024-01-02T17:56:40.750359Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2024-01-02T17:56:40.750363Z",
- "starts_at": "2024-01-02",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.750375Z",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get team campaign 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": "1f06a90e-8638-4f52-a706-68d85a7765c0",
- "inserted_at": "2024-01-02T17:56:41.890901Z",
- "legacy_id": 939164057,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:41.890936Z",
- "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": "df102564-9769-43cc-b024-ea83700a20e6",
- "legacy_id": 571855484,
- "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": "2782f607-3df3-4f0d-a4a0-9fc48063602b",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:41.909320Z",
}
}
List Team Campaigns
Lists the current cause Team Campaigns
Authorizations:
query Parameters
status | string Enum: "published" "retired" "unpublished" Example: status=published Use this parameter to filter Team Campaigns by the given status. |
supporting_type | string Enum: "invite_only" "none" "private" "public" Example: supporting_type=public Use this parameter to filter Team Campaigns by the given supporting type. |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only Team 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 Team Campaigns that have been updated before the given moment in ISO8601 format |
team_id | string Example: team_id=a2243df2-aea4-4dd0-8659-c47d21aaf69b Filter the given campaigns by a team id or legacy id |
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": "1f06a90e-8638-4f52-a706-68d85a7765c0",
- "inserted_at": "2024-01-02T17:56:41.890901Z",
- "legacy_id": 939164057,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:41.890936Z",
- "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": "df102564-9769-43cc-b024-ea83700a20e6",
- "legacy_id": 571855484,
- "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": "2782f607-3df3-4f0d-a4a0-9fc48063602b",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:41.909320Z",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top users
Authorizations:
path Parameters
team_campaign_id required | string Team 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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List campaigns supporting a Team Campaign
Authorizations:
path Parameters
team_campaign_id required | string Team 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": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "cause_id": "ceb42ca9-b389-499b-9175-9cbcc788445d",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "a4a140b1-f108-4442-ac72-2b167fffabf0",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "7cb1eaf4-9196-48ef-8143-f3d03459ac05",
- "inserted_at": "2024-01-02T17:56:40.215567Z",
- "legacy_id": 955494543,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:40.215601Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.215605Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "email": "fundraiser@tiltify.test",
- "id": "9fb818e4-d68a-4d71-a2d0-2ba3ca81248b",
- "legacy_id": 392068014,
- "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": "dd36bfe8-d033-4fc5-b0b5-f4da5797f457"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top donors
Authorizations:
path Parameters
team_campaign_id required | string Team 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
- 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": "d82743a1-46cc-4c8c-9469-57215ffa8c0c",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List Team Campaign rewards by Team Campaign ID
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"
}, - "description": "The streamer will pick a song and sing it poorly",
- "ends_at": "2024-01-02T17:56:41.336934Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "8be36e56-a6db-418b-8ed1-d70576df5bff",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-01-02T17:56:41.336977Z",
- "legacy_id": 424537660,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-01-02T17:56:41.337008Z",
- "updated_at": "2024-01-02T17:56:41.337012Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List Team Campaign polls by Team Campaign ID
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": "6057ef02-aa5c-40bb-9f38-97cb5413462a",
- "inserted_at": "2024-01-02T17:56:41.196033Z",
- "legacy_id": 820360970,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "1b2bd4ed-2222-4335-80a3-c78394d7f04d",
- "inserted_at": "2024-01-02T17:56:41.232656Z",
- "legacy_id": 546575664,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.232690Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "1b2bd4ed-2222-4335-80a3-c78394d7f04d",
- "inserted_at": "2024-01-02T17:56:41.232656Z",
- "legacy_id": 546575664,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.232690Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "1b2bd4ed-2222-4335-80a3-c78394d7f04d",
- "inserted_at": "2024-01-02T17:56:41.232656Z",
- "legacy_id": 546575664,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.232690Z"
}
], - "updated_at": "2024-01-02T17:56:41.316394Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List Team Campaign targets by Team Campaign ID
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-01-02T17:56:41.683941Z",
- "id": "d85e9039-6245-4f9b-a2c9-ebe8bcde561a",
- "inserted_at": "2024-01-02T17:56:41.683985Z",
- "legacy_id": 233573389,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.684007Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get team campaign by team slug and campaign slug
Returns a Team Campaign by its team slug and campaign slug
Authorizations:
path Parameters
team_slug required | string Team Slug |
team_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
}, - "currency_code": "USD",
- "description": "Let's fundraise togehter",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "1f06a90e-8638-4f52-a706-68d85a7765c0",
- "inserted_at": "2024-01-02T17:56:41.890901Z",
- "legacy_id": 939164057,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:41.890936Z",
- "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": "df102564-9769-43cc-b024-ea83700a20e6",
- "legacy_id": 571855484,
- "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": "2782f607-3df3-4f0d-a4a0-9fc48063602b",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:41.909320Z",
}
}
List Team Campaign schedules by Team Campaign ID
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-01-02T17:56:41.604289Z",
- "id": "bb62f570-5a88-41d4-94ea-002ff29798f3",
- "inserted_at": "2024-01-02T17:56:41.604332Z",
- "legacy_id": 265553902,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-01-02T17:56:41.604354Z",
- "updated_at": "2024-01-02T17:56:41.604359Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List Team Campaign donations by Team Campaign ID
Authorizations:
path Parameters
team_campaign_id required | string Team Campaign ID or legacy ID |
query Parameters
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 |
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 |
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only team_campaigns that have been created after the given moment in ISO8601 format |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only team_campaigns that have been created before the given moment in ISO8601 format |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only team_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 team_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": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "af7805b8-1c71-4c8f-8cf6-a3fc0b145224",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "91cdad68-efc3-4edc-8fd1-257e6ceb4257",
- "charity_can_contact": false,
- "completed_at": "2024-01-02T17:56:40.399459Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "b7f02b77-f313-49a8-b990-c31918bfc6bc",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "8281549e-1456-4423-b039-99a1e304b690",
- "legacy_id": 970414429,
- "moderated_at": "2024-01-02T17:56:40.660962Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "e130d834-aeb4-4d11-b6dd-64e670c379d7",
- "poll_option_id": "097f293a-ad0c-48cc-bd95-f2b626de6553",
- "reward_claims": [
- {
- "id": "f9aee7cd-5ec3-4dce-8587-cf5950665c9c",
- "quantity": 1,
- "reward_id": "a5a0bdd7-890d-490f-a072-66d1384e6770"
}
], - "reward_id": "213a07dd-f5ed-4baf-8ca9-f7a78355bfbe",
- "sustained": false,
- "target_id": "78863f0d-9511-4620-a397-177dcbe4f80a",
- "team_event_id": "f5928524-ede5-43e0-85ac-ba15e2263a49",
- "team_event_name": "Awesome Test Team Event"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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": "7ad1baeb-aab0-4e99-a1aa-dad1afbd6380",
- "inserted_at": "2024-01-02T17:56:41.112031Z",
- "legacy_id": 120875312,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-01-02T17:56:41.112071Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
Get donation by ID
Returns a donation by its ID
Authorizations:
path Parameters
donation_id required | string Donation ID |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "data": {
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "af7805b8-1c71-4c8f-8cf6-a3fc0b145224",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "91cdad68-efc3-4edc-8fd1-257e6ceb4257",
- "charity_can_contact": false,
- "completed_at": "2024-01-02T17:56:40.399459Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "b7f02b77-f313-49a8-b990-c31918bfc6bc",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "8281549e-1456-4423-b039-99a1e304b690",
- "legacy_id": 970414429,
- "moderated_at": "2024-01-02T17:56:40.660962Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "e130d834-aeb4-4d11-b6dd-64e670c379d7",
- "poll_option_id": "097f293a-ad0c-48cc-bd95-f2b626de6553",
- "reward_claims": [
- {
- "id": "f9aee7cd-5ec3-4dce-8587-cf5950665c9c",
- "quantity": 1,
- "reward_id": "a5a0bdd7-890d-490f-a072-66d1384e6770"
}
], - "reward_id": "213a07dd-f5ed-4baf-8ca9-f7a78355bfbe",
- "sustained": false,
- "target_id": "78863f0d-9511-4620-a397-177dcbe4f80a",
- "team_event_id": "f5928524-ede5-43e0-85ac-ba15e2263a49",
- "team_event_name": "Awesome Test Team Event"
}
}
List donations
Lists the current cause donations
Authorizations:
query Parameters
created_after | string Example: created_after=2021-11-02T14:24:55.811924Z Returns only campaigns that have been created after the given moment in ISO8601 format |
created_before | string Example: created_before=2021-11-02T14:24:55.811924Z Returns only campaigns that have been created before the given moment in ISO8601 format |
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": {
- "currency": "USD",
- "value": "182.32"
}, - "campaign_id": "af7805b8-1c71-4c8f-8cf6-a3fc0b145224",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "91cdad68-efc3-4edc-8fd1-257e6ceb4257",
- "charity_can_contact": false,
- "completed_at": "2024-01-02T17:56:40.399459Z",
- "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "b7f02b77-f313-49a8-b990-c31918bfc6bc",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "8281549e-1456-4423-b039-99a1e304b690",
- "legacy_id": 970414429,
- "moderated_at": "2024-01-02T17:56:40.660962Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "e130d834-aeb4-4d11-b6dd-64e670c379d7",
- "poll_option_id": "097f293a-ad0c-48cc-bd95-f2b626de6553",
- "reward_claims": [
- {
- "id": "f9aee7cd-5ec3-4dce-8587-cf5950665c9c",
- "quantity": 1,
- "reward_id": "a5a0bdd7-890d-490f-a072-66d1384e6770"
}
], - "reward_id": "213a07dd-f5ed-4baf-8ca9-f7a78355bfbe",
- "sustained": false,
- "target_id": "78863f0d-9511-4620-a397-177dcbe4f80a",
- "team_event_id": "f5928524-ede5-43e0-85ac-ba15e2263a49",
- "team_event_name": "Awesome Test Team Event"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List cause supporting events
Authorizations:
query Parameters
status | string Enum: "published" "retired" "unpublished" Example: status=published Use this parameter to filter events by the given status. |
supporting_type | string Enum: "invite_only" "none" "private" "public" Example: supporting_type=public Use this parameter to filter events by the given supporting type. |
updated_after | string Example: updated_after=2021-11-02T14:24:55.811924Z Returns only events 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 events 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
}, - "cause_id": "ceb42ca9-b389-499b-9175-9cbcc788445d",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "a4a140b1-f108-4442-ac72-2b167fffabf0",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "7cb1eaf4-9196-48ef-8143-f3d03459ac05",
- "inserted_at": "2024-01-02T17:56:40.215567Z",
- "legacy_id": 955494543,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-01-02T17:56:40.215601Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-01-02T17:56:40.215605Z",
- "user": {
- "avatar": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "description": "Professional twitch streamer who likes charity!",
- "email": "fundraiser@tiltify.test",
- "id": "9fb818e4-d68a-4d71-a2d0-2ba3ca81248b",
- "legacy_id": 392068014,
- "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": "dd36bfe8-d033-4fc5-b0b5-f4da5797f457"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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": "9cbfdef7-e275-4f0a-8761-8224a0d39778",
- "inserted_at": "2024-01-02T17:56:40.255768Z",
- "legacy_id": 773551729,
- "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"
}, - "status": "published",
- "updated_at": "2024-01-02T17:56:40.255803Z"
}
}