V5ApiCause (1.0)
Download OpenAPI specification:Download
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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "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": "21b9f0ca-4242-4ca5-ba2c-9c965c8eab1a",
- "inserted_at": "2024-09-03T18:26:35.099093Z",
- "updated_at": "2024-09-03T18:26:35.099110Z"
}
], - "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "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-09-03T18:26:33.700507Z",
- "cause_id": "e17a928d-3c71-4632-a39b-1cb8cfaade5f",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2024-09-03T18:26:33.700504Z",
- "ends_at": "2024-09-03",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "37bb0e81-c5a9-4b56-9960-32413b284f0f",
- "inserted_at": "2024-09-03T18:26:33.700458Z",
- "legacy_id": 629734224,
- "name": "Spooktober 2022",
- "published_at": "2024-09-03T18:26:33.700486Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2024-09-03T18:26:33.700501Z",
- "starts_at": "2024-09-03",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:33.700515Z",
}
], - "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-09-03T18:26:34.645833Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "4953f03c-b94d-4c45-98d3-5b48ce18cef5",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-09-03T18:26:34.645871Z",
- "legacy_id": 339726694,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-09-03T18:26:34.645898Z",
- "updated_at": "2024-09-03T18:26:34.645902Z"
}
], - "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "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": "58929161-07ea-4b42-80c4-3785a0f828ec",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-09-03T18:26:34.441278Z",
- "is_milestone": true,
- "legacy_id": 765748442,
- "name": "Holiday Special Livestream",
- "updated_at": "2024-09-03T18:26:34.441308Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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": "a3f0030f-4179-4b41-b5b7-899bccc7e606",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "7f5e1e3f-bc44-40c8-a9cd-a9f65b0b71dc",
- "charity_can_contact": false,
- "completed_at": "2024-11-13T20:04:12.308655Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-09T17:33:18.387586Z",
- "donation_id": "51e294d3-46af-443a-9aec-478394a9c9ec",
- "ends_at": "2024-10-09T17:33:18.387582Z",
- "id": "082d73ae-fb6d-472c-80a3-0c24cee62744",
- "inserted_at": "2024-10-09T17:33:18.387559Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-09T17:33:18.387578Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-09T17:33:18.387574Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "27ab8aed-0d6f-4ac5-9158-372e59505177",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "1a8808b5-aee3-4ce8-b028-9ef402b60598",
- "legacy_id": 51558945,
- "moderated_at": "2024-11-13T20:04:12.479786Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "49159b71-042c-481b-b712-9674c7bf5c5e",
- "poll_option_id": "db8f5a67-8493-4b7f-ae6c-d723246b9550",
- "reward_claims": [
- {
- "id": "a1ec1d8c-4ef0-4fc9-a86b-824a40e0907f",
- "quantity": 1,
- "reward_id": "50dbb15c-c29e-4394-bead-7890f692bf39"
}
], - "reward_id": "2ccc0968-8e86-4430-893c-a33367e6a8d0",
- "sustained": false,
- "target_id": "0e5eda33-6ccc-4fce-89fc-a6911399dba2",
- "team_event_id": "4a40d89e-0d06-4e4d-865c-80f49e67aa9c",
- "team_event_name": "Awesome Test Team Event"
}
], - "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-09-03T18:26:33.700507Z",
- "cause_id": "e17a928d-3c71-4632-a39b-1cb8cfaade5f",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2024-09-03T18:26:33.700504Z",
- "ends_at": "2024-09-03",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "37bb0e81-c5a9-4b56-9960-32413b284f0f",
- "inserted_at": "2024-09-03T18:26:33.700458Z",
- "legacy_id": 629734224,
- "name": "Spooktober 2022",
- "published_at": "2024-09-03T18:26:33.700486Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2024-09-03T18:26:33.700501Z",
- "starts_at": "2024-09-03",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:33.700515Z",
}
}
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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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": "2df1b815-d67f-4bc8-ac03-a4587b1aa503",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "277d6a9f-c0ab-4366-ad5a-96beda3c7d4a",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "bad17e8a-c559-4494-bb0b-c5cf0d510f19",
- "inserted_at": "2024-09-03T18:26:34.129864Z",
- "legacy_id": 328486018,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.129893Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.129897Z",
- "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": "6cc233be-e523-4fad-ab57-d290b574a2e7",
- "legacy_id": 531721921,
- "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": "4799ed2d-167c-4361-9600-28406359387c"
}
], - "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "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": "bb9e441a-3370-4ba0-8ef5-73bf06c7a3e3",
- "inserted_at": "2024-09-03T18:26:34.808478Z",
- "legacy_id": 956672439,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.808509Z",
- "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": "1470f78e-f3f3-41ac-b3ee-6e80fc1049fd",
- "legacy_id": 629672320,
- "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": "ef8300fe-48ea-48e2-8d99-429cfc1c3648",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.808517Z",
}
}
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": "2df1b815-d67f-4bc8-ac03-a4587b1aa503",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "277d6a9f-c0ab-4366-ad5a-96beda3c7d4a",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "bad17e8a-c559-4494-bb0b-c5cf0d510f19",
- "inserted_at": "2024-09-03T18:26:34.129864Z",
- "legacy_id": 328486018,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.129893Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.129897Z",
- "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": "6cc233be-e523-4fad-ab57-d290b574a2e7",
- "legacy_id": 531721921,
- "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": "4799ed2d-167c-4361-9600-28406359387c"
}
], - "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": "a3f0030f-4179-4b41-b5b7-899bccc7e606",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "7f5e1e3f-bc44-40c8-a9cd-a9f65b0b71dc",
- "charity_can_contact": false,
- "completed_at": "2024-11-13T20:04:12.308655Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-09T17:33:18.387586Z",
- "donation_id": "51e294d3-46af-443a-9aec-478394a9c9ec",
- "ends_at": "2024-10-09T17:33:18.387582Z",
- "id": "082d73ae-fb6d-472c-80a3-0c24cee62744",
- "inserted_at": "2024-10-09T17:33:18.387559Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-09T17:33:18.387578Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-09T17:33:18.387574Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "27ab8aed-0d6f-4ac5-9158-372e59505177",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "1a8808b5-aee3-4ce8-b028-9ef402b60598",
- "legacy_id": 51558945,
- "moderated_at": "2024-11-13T20:04:12.479786Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "49159b71-042c-481b-b712-9674c7bf5c5e",
- "poll_option_id": "db8f5a67-8493-4b7f-ae6c-d723246b9550",
- "reward_claims": [
- {
- "id": "a1ec1d8c-4ef0-4fc9-a86b-824a40e0907f",
- "quantity": 1,
- "reward_id": "50dbb15c-c29e-4394-bead-7890f692bf39"
}
], - "reward_id": "2ccc0968-8e86-4430-893c-a33367e6a8d0",
- "sustained": false,
- "target_id": "0e5eda33-6ccc-4fce-89fc-a6911399dba2",
- "team_event_id": "4a40d89e-0d06-4e4d-865c-80f49e67aa9c",
- "team_event_name": "Awesome Test Team Event"
}
], - "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "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-09-03T18:26:34.750947Z",
- "id": "d77d6119-1377-4301-b49d-4075bec00e0d",
- "inserted_at": "2024-09-03T18:26:34.751429Z",
- "legacy_id": 407491933,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.751452Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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-09-03T18:26:32.068889Z",
- "id": "0a353119-5164-49b1-83d5-84f4c4492966",
- "inserted_at": "2024-09-03T18:26:32.068935Z",
- "legacy_id": 856587234,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-09-03T18:26:32.068951Z",
- "updated_at": "2024-09-03T18:26:32.068954Z"
}
], - "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": "bb9e441a-3370-4ba0-8ef5-73bf06c7a3e3",
- "inserted_at": "2024-09-03T18:26:34.808478Z",
- "legacy_id": 956672439,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.808509Z",
- "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": "1470f78e-f3f3-41ac-b3ee-6e80fc1049fd",
- "legacy_id": 629672320,
- "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": "ef8300fe-48ea-48e2-8d99-429cfc1c3648",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.808517Z",
}
}
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=6e84ec31-79a0-4bf6-9f9b-d77f3be87ae3 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": "bb9e441a-3370-4ba0-8ef5-73bf06c7a3e3",
- "inserted_at": "2024-09-03T18:26:34.808478Z",
- "legacy_id": 956672439,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.808509Z",
- "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": "1470f78e-f3f3-41ac-b3ee-6e80fc1049fd",
- "legacy_id": 629672320,
- "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": "ef8300fe-48ea-48e2-8d99-429cfc1c3648",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.808517Z",
}
], - "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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "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": "85d70944-1405-418f-ac07-3c644562fa82",
- "inserted_at": "2024-09-03T18:26:34.624596Z",
- "legacy_id": 894914163,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ab041b28-c341-4a32-89b6-988e45a5be73",
- "inserted_at": "2024-09-03T18:26:34.625430Z",
- "legacy_id": 5865656,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.625444Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ab041b28-c341-4a32-89b6-988e45a5be73",
- "inserted_at": "2024-09-03T18:26:34.625430Z",
- "legacy_id": 5865656,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.625444Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ab041b28-c341-4a32-89b6-988e45a5be73",
- "inserted_at": "2024-09-03T18:26:34.625430Z",
- "legacy_id": 5865656,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.625444Z"
}
], - "updated_at": "2024-09-03T18:26:34.717833Z"
}
], - "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-09-03T18:26:34.645833Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "4953f03c-b94d-4c45-98d3-5b48ce18cef5",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-09-03T18:26:34.645871Z",
- "legacy_id": 339726694,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-09-03T18:26:34.645898Z",
- "updated_at": "2024-09-03T18:26:34.645902Z"
}
], - "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": "905bd095-d12c-439c-9205-274bb3f6e269",
- "inserted_at": "2024-09-03T18:26:34.547817Z",
- "legacy_id": 848531749,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.547847Z"
}
], - "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: "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 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=aa9b2269-30ae-4590-b3e1-781aa21c238a 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": "2df1b815-d67f-4bc8-ac03-a4587b1aa503",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "277d6a9f-c0ab-4366-ad5a-96beda3c7d4a",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "bad17e8a-c559-4494-bb0b-c5cf0d510f19",
- "inserted_at": "2024-09-03T18:26:34.129864Z",
- "legacy_id": 328486018,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.129893Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.129897Z",
- "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": "6cc233be-e523-4fad-ab57-d290b574a2e7",
- "legacy_id": 531721921,
- "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": "4799ed2d-167c-4361-9600-28406359387c"
}
], - "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-10-09T17:33:18.387586Z",
- "donation_id": "51e294d3-46af-443a-9aec-478394a9c9ec",
- "ends_at": "2024-10-09T17:33:18.387582Z",
- "id": "082d73ae-fb6d-472c-80a3-0c24cee62744",
- "inserted_at": "2024-10-09T17:33:18.387559Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-09T17:33:18.387578Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-09T17:33:18.387574Z"
}
], - "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": "2df1b815-d67f-4bc8-ac03-a4587b1aa503",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "277d6a9f-c0ab-4366-ad5a-96beda3c7d4a",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "bad17e8a-c559-4494-bb0b-c5cf0d510f19",
- "inserted_at": "2024-09-03T18:26:34.129864Z",
- "legacy_id": 328486018,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.129893Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.129897Z",
- "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": "6cc233be-e523-4fad-ab57-d290b574a2e7",
- "legacy_id": 531721921,
- "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": "4799ed2d-167c-4361-9600-28406359387c"
}
}
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-09-03T18:26:34.645833Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "4953f03c-b94d-4c45-98d3-5b48ce18cef5",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2024-09-03T18:26:34.645871Z",
- "legacy_id": 339726694,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2024-09-03T18:26:34.645898Z",
- "updated_at": "2024-09-03T18:26:34.645902Z"
}
], - "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": "2df1b815-d67f-4bc8-ac03-a4587b1aa503",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "277d6a9f-c0ab-4366-ad5a-96beda3c7d4a",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "bad17e8a-c559-4494-bb0b-c5cf0d510f19",
- "inserted_at": "2024-09-03T18:26:34.129864Z",
- "legacy_id": 328486018,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.129893Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.129897Z",
- "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": "6cc233be-e523-4fad-ab57-d290b574a2e7",
- "legacy_id": 531721921,
- "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": "4799ed2d-167c-4361-9600-28406359387c"
}
}
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": "85d70944-1405-418f-ac07-3c644562fa82",
- "inserted_at": "2024-09-03T18:26:34.624596Z",
- "legacy_id": 894914163,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ab041b28-c341-4a32-89b6-988e45a5be73",
- "inserted_at": "2024-09-03T18:26:34.625430Z",
- "legacy_id": 5865656,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.625444Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ab041b28-c341-4a32-89b6-988e45a5be73",
- "inserted_at": "2024-09-03T18:26:34.625430Z",
- "legacy_id": 5865656,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.625444Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "ab041b28-c341-4a32-89b6-988e45a5be73",
- "inserted_at": "2024-09-03T18:26:34.625430Z",
- "legacy_id": 5865656,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.625444Z"
}
], - "updated_at": "2024-09-03T18:26:34.717833Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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-09-03T18:26:32.068889Z",
- "id": "0a353119-5164-49b1-83d5-84f4c4492966",
- "inserted_at": "2024-09-03T18:26:32.068935Z",
- "legacy_id": 856587234,
- "name": "Holiday Special Livestream",
- "starts_at": "2024-09-03T18:26:32.068951Z",
- "updated_at": "2024-09-03T18:26:32.068954Z"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
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": "42808909-4699-4894-92ba-ffd9069b3e4d",
- "name": "Awesome Team",
}
], - "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": "905bd095-d12c-439c-9205-274bb3f6e269",
- "inserted_at": "2024-09-03T18:26:34.547817Z",
- "legacy_id": 848531749,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.547847Z"
}
], - "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-09-03T18:26:34.750947Z",
- "id": "d77d6119-1377-4301-b49d-4075bec00e0d",
- "inserted_at": "2024-09-03T18:26:34.751429Z",
- "legacy_id": 407491933,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2024-09-03T18:26:34.751452Z"
}
], - "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": "a3f0030f-4179-4b41-b5b7-899bccc7e606",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "7f5e1e3f-bc44-40c8-a9cd-a9f65b0b71dc",
- "charity_can_contact": false,
- "completed_at": "2024-11-13T20:04:12.308655Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-09T17:33:18.387586Z",
- "donation_id": "51e294d3-46af-443a-9aec-478394a9c9ec",
- "ends_at": "2024-10-09T17:33:18.387582Z",
- "id": "082d73ae-fb6d-472c-80a3-0c24cee62744",
- "inserted_at": "2024-10-09T17:33:18.387559Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-09T17:33:18.387578Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-09T17:33:18.387574Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "27ab8aed-0d6f-4ac5-9158-372e59505177",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "1a8808b5-aee3-4ce8-b028-9ef402b60598",
- "legacy_id": 51558945,
- "moderated_at": "2024-11-13T20:04:12.479786Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "49159b71-042c-481b-b712-9674c7bf5c5e",
- "poll_option_id": "db8f5a67-8493-4b7f-ae6c-d723246b9550",
- "reward_claims": [
- {
- "id": "a1ec1d8c-4ef0-4fc9-a86b-824a40e0907f",
- "quantity": 1,
- "reward_id": "50dbb15c-c29e-4394-bead-7890f692bf39"
}
], - "reward_id": "2ccc0968-8e86-4430-893c-a33367e6a8d0",
- "sustained": false,
- "target_id": "0e5eda33-6ccc-4fce-89fc-a6911399dba2",
- "team_event_id": "4a40d89e-0d06-4e4d-865c-80f49e67aa9c",
- "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": "2df1b815-d67f-4bc8-ac03-a4587b1aa503",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "277d6a9f-c0ab-4366-ad5a-96beda3c7d4a",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "bad17e8a-c559-4494-bb0b-c5cf0d510f19",
- "inserted_at": "2024-09-03T18:26:34.129864Z",
- "legacy_id": 328486018,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "published_at": "2024-09-03T18:26:34.129893Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-09-03T18:26:34.129897Z",
- "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": "6cc233be-e523-4fad-ab57-d290b574a2e7",
- "legacy_id": 531721921,
- "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": "4799ed2d-167c-4361-9600-28406359387c"
}
], - "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": "00abb960-8ee7-42f3-b9cd-0b91d83f7823",
- "inserted_at": "2024-09-03T18:26:33.416128Z",
- "legacy_id": 506830531,
- "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-09-03T18:26:33.416158Z"
}
}
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": "a3f0030f-4179-4b41-b5b7-899bccc7e606",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "7f5e1e3f-bc44-40c8-a9cd-a9f65b0b71dc",
- "charity_can_contact": false,
- "completed_at": "2024-11-13T20:04:12.308655Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-09T17:33:18.387586Z",
- "donation_id": "51e294d3-46af-443a-9aec-478394a9c9ec",
- "ends_at": "2024-10-09T17:33:18.387582Z",
- "id": "082d73ae-fb6d-472c-80a3-0c24cee62744",
- "inserted_at": "2024-10-09T17:33:18.387559Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-09T17:33:18.387578Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-09T17:33:18.387574Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "27ab8aed-0d6f-4ac5-9158-372e59505177",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "1a8808b5-aee3-4ce8-b028-9ef402b60598",
- "legacy_id": 51558945,
- "moderated_at": "2024-11-13T20:04:12.479786Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "49159b71-042c-481b-b712-9674c7bf5c5e",
- "poll_option_id": "db8f5a67-8493-4b7f-ae6c-d723246b9550",
- "reward_claims": [
- {
- "id": "a1ec1d8c-4ef0-4fc9-a86b-824a40e0907f",
- "quantity": 1,
- "reward_id": "50dbb15c-c29e-4394-bead-7890f692bf39"
}
], - "reward_id": "2ccc0968-8e86-4430-893c-a33367e6a8d0",
- "sustained": false,
- "target_id": "0e5eda33-6ccc-4fce-89fc-a6911399dba2",
- "team_event_id": "4a40d89e-0d06-4e4d-865c-80f49e67aa9c",
- "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": "a3f0030f-4179-4b41-b5b7-899bccc7e606",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "7f5e1e3f-bc44-40c8-a9cd-a9f65b0b71dc",
- "charity_can_contact": false,
- "completed_at": "2024-11-13T20:04:12.308655Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2024-10-09T17:33:18.387586Z",
- "donation_id": "51e294d3-46af-443a-9aec-478394a9c9ec",
- "ends_at": "2024-10-09T17:33:18.387582Z",
- "id": "082d73ae-fb6d-472c-80a3-0c24cee62744",
- "inserted_at": "2024-10-09T17:33:18.387559Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2024-10-09T17:33:18.387578Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2024-10-09T17:33:18.387574Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "fundraising_event_id": "27ab8aed-0d6f-4ac5-9158-372e59505177",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "1a8808b5-aee3-4ce8-b028-9ef402b60598",
- "legacy_id": 51558945,
- "moderated_at": "2024-11-13T20:04:12.479786Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "49159b71-042c-481b-b712-9674c7bf5c5e",
- "poll_option_id": "db8f5a67-8493-4b7f-ae6c-d723246b9550",
- "reward_claims": [
- {
- "id": "a1ec1d8c-4ef0-4fc9-a86b-824a40e0907f",
- "quantity": 1,
- "reward_id": "50dbb15c-c29e-4394-bead-7890f692bf39"
}
], - "reward_id": "2ccc0968-8e86-4430-893c-a33367e6a8d0",
- "sustained": false,
- "target_id": "0e5eda33-6ccc-4fce-89fc-a6911399dba2",
- "team_event_id": "4a40d89e-0d06-4e4d-865c-80f49e67aa9c",
- "team_event_name": "Awesome Test Team Event"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}