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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "0c12679f-ec6e-4970-bdc9-f6a9a9134c2d",
- "inserted_at": "2025-06-30T15:59:25.191070Z",
- "updated_at": "2025-06-30T15:59:25.191084Z"
}
], - "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "2025-06-30T15:59:23.744597Z",
- "cause_id": "7de18999-1ff3-446a-b8de-2d93e5603c98",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2025-06-30T15:59:23.744593Z",
- "ends_at": "2025-06-30",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "17ad445b-03a2-4abd-ac51-5568269e3f53",
- "inserted_at": "2025-06-30T15:59:23.744537Z",
- "legacy_id": 742535669,
- "name": "Spooktober 2022",
- "published_at": "2025-06-30T15:59:23.744568Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2025-06-30T15:59:23.744588Z",
- "starts_at": "2025-06-30",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:23.744603Z",
}
], - "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": "2025-06-30T15:59:24.665330Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "0228aa52-734b-4430-9928-268a84bd2fe4",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2025-06-30T15:59:24.665370Z",
- "legacy_id": 7434909,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2025-06-30T15:59:24.665387Z",
- "updated_at": "2025-06-30T15:59:24.665390Z"
}
], - "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "4c95ce13-d54b-4025-a0ca-976949e6d9eb",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2025-06-30T15:59:24.364699Z",
- "is_milestone": true,
- "legacy_id": 999098720,
- "name": "Holiday Special Livestream",
- "updated_at": "2025-06-30T15:59:24.364728Z"
}
], - "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": "fad4d063-7ad5-4070-8df4-e8e56b737f4c",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "0653425e-efd8-4ef2-b849-fc4f76868dbf",
- "charity_can_contact": false,
- "completed_at": "2025-06-30T15:59:24.202582Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-06-30T15:59:24.203941Z",
- "donation_id": "287bf125-b190-48b6-a304-32db1f585ccc",
- "ends_at": "2025-06-30T15:59:24.203938Z",
- "id": "0ea69b8a-4bbc-488a-9b3a-c9704f3d241e",
- "inserted_at": "2025-06-30T15:59:24.203920Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-06-30T15:59:24.203934Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.203929Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "40ea787f-72de-484d-ac6d-2a24a7730afa",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "c14a15b9-29f6-4da6-a42e-1f42ea4091e5",
- "legacy_id": 282633623,
- "moderated_at": "2025-06-30T15:59:25.587853Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "456522e9-c307-4018-bd97-3ca05bf6c2e6",
- "poll_option_id": "8309ea7d-9aeb-4dec-9b0c-67fd578d785f",
- "reward_claims": [
- {
- "id": "450b9dae-c9f6-4374-9910-031b1f1715d3",
- "quantity": 1,
- "reward_id": "ab892c34-a918-4fc2-a70d-2e2e2593a2a1"
}
], - "reward_id": "fe082716-780e-4e4f-91ce-8f4ad70f3165",
- "sustained": false,
- "target_id": "c467f53d-ea2a-4676-b1ac-56d5d9860c82",
- "team_event_id": "dd32f90d-318f-400f-8e84-f10d7b398dd9",
- "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": "2025-06-30T15:59:23.744597Z",
- "cause_id": "7de18999-1ff3-446a-b8de-2d93e5603c98",
- "currency_code": "USD",
- "description": "Let's get **spooooky**!",
- "end_supporting_at": "2025-06-30T15:59:23.744593Z",
- "ends_at": "2025-06-30",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "17ad445b-03a2-4abd-ac51-5568269e3f53",
- "inserted_at": "2025-06-30T15:59:23.744537Z",
- "legacy_id": 742535669,
- "name": "Spooktober 2022",
- "published_at": "2025-06-30T15:59:23.744568Z",
- "retired_at": null,
- "slug": "spooktober-2022",
- "start_supporting_at": "2025-06-30T15:59:23.744588Z",
- "starts_at": "2025-06-30",
- "status": "published",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:23.744603Z",
}
}
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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "027a8c83-dc5e-4ec7-88e4-f72502bef8ca",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "42da2ccd-8f98-4f2c-9ce1-ffc7d62a27cd",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "52280ba8-7639-4ed2-b0a7-48af9141ad86",
- "inserted_at": "2025-06-30T15:59:24.023276Z",
- "legacy_id": 394782949,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.023306Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "team_campaign_id": "85ada071-eb80-4812-ab7c-e9bd5bd7a003",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.023312Z",
- "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": "a1b05830-ee42-4f17-87e6-0c7775a5559e",
- "legacy_id": 579952411,
- "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": "05046e9d-79e2-4aa4-acb9-54bd4f66127a"
}
], - "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "e9043a16-fd36-4a63-a264-ed3028b734c0",
- "inserted_at": "2025-06-30T15:59:24.798086Z",
- "legacy_id": 674747556,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.798114Z",
- "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": "7e69f5d0-0313-4f73-8178-e353f31a299d",
- "legacy_id": 446416913,
- "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": "7bad6a3e-9c70-49ad-8bdb-59d8813eb950",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.798122Z",
}
}
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": "027a8c83-dc5e-4ec7-88e4-f72502bef8ca",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "42da2ccd-8f98-4f2c-9ce1-ffc7d62a27cd",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "52280ba8-7639-4ed2-b0a7-48af9141ad86",
- "inserted_at": "2025-06-30T15:59:24.023276Z",
- "legacy_id": 394782949,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.023306Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "team_campaign_id": "85ada071-eb80-4812-ab7c-e9bd5bd7a003",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.023312Z",
- "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": "a1b05830-ee42-4f17-87e6-0c7775a5559e",
- "legacy_id": 579952411,
- "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": "05046e9d-79e2-4aa4-acb9-54bd4f66127a"
}
], - "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": "fad4d063-7ad5-4070-8df4-e8e56b737f4c",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "0653425e-efd8-4ef2-b849-fc4f76868dbf",
- "charity_can_contact": false,
- "completed_at": "2025-06-30T15:59:24.202582Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-06-30T15:59:24.203941Z",
- "donation_id": "287bf125-b190-48b6-a304-32db1f585ccc",
- "ends_at": "2025-06-30T15:59:24.203938Z",
- "id": "0ea69b8a-4bbc-488a-9b3a-c9704f3d241e",
- "inserted_at": "2025-06-30T15:59:24.203920Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-06-30T15:59:24.203934Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.203929Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "40ea787f-72de-484d-ac6d-2a24a7730afa",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "c14a15b9-29f6-4da6-a42e-1f42ea4091e5",
- "legacy_id": 282633623,
- "moderated_at": "2025-06-30T15:59:25.587853Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "456522e9-c307-4018-bd97-3ca05bf6c2e6",
- "poll_option_id": "8309ea7d-9aeb-4dec-9b0c-67fd578d785f",
- "reward_claims": [
- {
- "id": "450b9dae-c9f6-4374-9910-031b1f1715d3",
- "quantity": 1,
- "reward_id": "ab892c34-a918-4fc2-a70d-2e2e2593a2a1"
}
], - "reward_id": "fe082716-780e-4e4f-91ce-8f4ad70f3165",
- "sustained": false,
- "target_id": "c467f53d-ea2a-4676-b1ac-56d5d9860c82",
- "team_event_id": "dd32f90d-318f-400f-8e84-f10d7b398dd9",
- "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "2025-06-30T15:59:24.759727Z",
- "id": "3e5470d4-50d6-41a0-934d-c4c345ec89e1",
- "inserted_at": "2025-06-30T15:59:24.759766Z",
- "legacy_id": 504014840,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.759784Z"
}
], - "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": "2025-06-30T15:59:22.265718Z",
- "id": "3b974d93-75cc-45c7-a4ea-4b2825570ca9",
- "inserted_at": "2025-06-30T15:59:22.265764Z",
- "legacy_id": 437879901,
- "name": "Holiday Special Livestream",
- "starts_at": "2025-06-30T15:59:22.265783Z",
- "updated_at": "2025-06-30T15:59:22.265788Z"
}
], - "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": "e9043a16-fd36-4a63-a264-ed3028b734c0",
- "inserted_at": "2025-06-30T15:59:24.798086Z",
- "legacy_id": 674747556,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.798114Z",
- "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": "7e69f5d0-0313-4f73-8178-e353f31a299d",
- "legacy_id": 446416913,
- "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": "7bad6a3e-9c70-49ad-8bdb-59d8813eb950",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.798122Z",
}
}
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=c46e6d22-91a6-4cc2-ae24-e7ce4c6d50d8 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": "e9043a16-fd36-4a63-a264-ed3028b734c0",
- "inserted_at": "2025-06-30T15:59:24.798086Z",
- "legacy_id": 674747556,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "Our Awesome Team Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.798114Z",
- "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": "7e69f5d0-0313-4f73-8178-e353f31a299d",
- "legacy_id": 446416913,
- "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": "7bad6a3e-9c70-49ad-8bdb-59d8813eb950",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.798122Z",
}
], - "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "48350c3b-28c0-4ecf-9543-577bd7746fc4",
- "inserted_at": "2025-06-30T15:59:24.630801Z",
- "legacy_id": 549854757,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "adcfbead-e8e1-429f-99c7-a2e63d4b6a43",
- "inserted_at": "2025-06-30T15:59:24.631712Z",
- "legacy_id": 231776936,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.631728Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "adcfbead-e8e1-429f-99c7-a2e63d4b6a43",
- "inserted_at": "2025-06-30T15:59:24.631712Z",
- "legacy_id": 231776936,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.631728Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "adcfbead-e8e1-429f-99c7-a2e63d4b6a43",
- "inserted_at": "2025-06-30T15:59:24.631712Z",
- "legacy_id": 231776936,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.631728Z"
}
], - "updated_at": "2025-06-30T15:59:24.712471Z"
}
], - "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": "2025-06-30T15:59:24.665330Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "0228aa52-734b-4430-9928-268a84bd2fe4",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2025-06-30T15:59:24.665370Z",
- "legacy_id": 7434909,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2025-06-30T15:59:24.665387Z",
- "updated_at": "2025-06-30T15:59:24.665390Z"
}
], - "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": "353adaa7-144a-40b4-9331-63d5a845a161",
- "inserted_at": "2025-06-30T15:59:24.577003Z",
- "legacy_id": 651293918,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.577032Z"
}
], - "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=d89bb134-16ad-42c4-ac52-985cb5eb5cdd 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": "027a8c83-dc5e-4ec7-88e4-f72502bef8ca",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "42da2ccd-8f98-4f2c-9ce1-ffc7d62a27cd",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "52280ba8-7639-4ed2-b0a7-48af9141ad86",
- "inserted_at": "2025-06-30T15:59:24.023276Z",
- "legacy_id": 394782949,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.023306Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "team_campaign_id": "85ada071-eb80-4812-ab7c-e9bd5bd7a003",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.023312Z",
- "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": "a1b05830-ee42-4f17-87e6-0c7775a5559e",
- "legacy_id": 579952411,
- "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": "05046e9d-79e2-4aa4-acb9-54bd4f66127a"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}
List top fundraisers
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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "name": "Awesome Team",
}
], - "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": "2025-06-30T15:59:24.203941Z",
- "donation_id": "287bf125-b190-48b6-a304-32db1f585ccc",
- "ends_at": "2025-06-30T15:59:24.203938Z",
- "id": "0ea69b8a-4bbc-488a-9b3a-c9704f3d241e",
- "inserted_at": "2025-06-30T15:59:24.203920Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-06-30T15:59:24.203934Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.203929Z"
}
], - "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": "027a8c83-dc5e-4ec7-88e4-f72502bef8ca",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "42da2ccd-8f98-4f2c-9ce1-ffc7d62a27cd",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "52280ba8-7639-4ed2-b0a7-48af9141ad86",
- "inserted_at": "2025-06-30T15:59:24.023276Z",
- "legacy_id": 394782949,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.023306Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "team_campaign_id": "85ada071-eb80-4812-ab7c-e9bd5bd7a003",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.023312Z",
- "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": "a1b05830-ee42-4f17-87e6-0c7775a5559e",
- "legacy_id": 579952411,
- "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": "05046e9d-79e2-4aa4-acb9-54bd4f66127a"
}
}
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": "2025-06-30T15:59:24.665330Z",
- "fair_market_value": {
- "currency": "USD",
- "value": "182.32"
}, - "highlighted": true,
- "id": "0228aa52-734b-4430-9928-268a84bd2fe4",
- "image": {
- "alt": "Short image description used as alternative text.",
- "height": 200,
- "width": 200
}, - "inserted_at": "2025-06-30T15:59:24.665370Z",
- "legacy_id": 7434909,
- "name": "Sing a Song Poorly",
- "quantity": 1000,
- "quantity_remaining": 23,
- "starts_at": "2025-06-30T15:59:24.665387Z",
- "updated_at": "2025-06-30T15:59:24.665390Z"
}
], - "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": "027a8c83-dc5e-4ec7-88e4-f72502bef8ca",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "42da2ccd-8f98-4f2c-9ce1-ffc7d62a27cd",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "52280ba8-7639-4ed2-b0a7-48af9141ad86",
- "inserted_at": "2025-06-30T15:59:24.023276Z",
- "legacy_id": 394782949,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.023306Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "team_campaign_id": "85ada071-eb80-4812-ab7c-e9bd5bd7a003",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.023312Z",
- "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": "a1b05830-ee42-4f17-87e6-0c7775a5559e",
- "legacy_id": 579952411,
- "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": "05046e9d-79e2-4aa4-acb9-54bd4f66127a"
}
}
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": "48350c3b-28c0-4ecf-9543-577bd7746fc4",
- "inserted_at": "2025-06-30T15:59:24.630801Z",
- "legacy_id": 549854757,
- "name": "Learn a TikTok dance live!",
- "options": [
- {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "adcfbead-e8e1-429f-99c7-a2e63d4b6a43",
- "inserted_at": "2025-06-30T15:59:24.631712Z",
- "legacy_id": 231776936,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.631728Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "adcfbead-e8e1-429f-99c7-a2e63d4b6a43",
- "inserted_at": "2025-06-30T15:59:24.631712Z",
- "legacy_id": 231776936,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.631728Z"
}, - {
- "amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "id": "adcfbead-e8e1-429f-99c7-a2e63d4b6a43",
- "inserted_at": "2025-06-30T15:59:24.631712Z",
- "legacy_id": 231776936,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.631728Z"
}
], - "updated_at": "2025-06-30T15:59:24.712471Z"
}
], - "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": "2025-06-30T15:59:22.265718Z",
- "id": "3b974d93-75cc-45c7-a4ea-4b2825570ca9",
- "inserted_at": "2025-06-30T15:59:22.265764Z",
- "legacy_id": 437879901,
- "name": "Holiday Special Livestream",
- "starts_at": "2025-06-30T15:59:22.265783Z",
- "updated_at": "2025-06-30T15:59:22.265788Z"
}
], - "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": "424679dd-d536-4256-8ae9-4e0398b40b37",
- "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": "353adaa7-144a-40b4-9331-63d5a845a161",
- "inserted_at": "2025-06-30T15:59:24.577003Z",
- "legacy_id": 651293918,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.577032Z"
}
], - "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": "2025-06-30T15:59:24.759727Z",
- "id": "3e5470d4-50d6-41a0-934d-c4c345ec89e1",
- "inserted_at": "2025-06-30T15:59:24.759766Z",
- "legacy_id": 504014840,
- "name": "Learn a TikTok dance live!",
- "updated_at": "2025-06-30T15:59:24.759784Z"
}
], - "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": "fad4d063-7ad5-4070-8df4-e8e56b737f4c",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "0653425e-efd8-4ef2-b849-fc4f76868dbf",
- "charity_can_contact": false,
- "completed_at": "2025-06-30T15:59:24.202582Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-06-30T15:59:24.203941Z",
- "donation_id": "287bf125-b190-48b6-a304-32db1f585ccc",
- "ends_at": "2025-06-30T15:59:24.203938Z",
- "id": "0ea69b8a-4bbc-488a-9b3a-c9704f3d241e",
- "inserted_at": "2025-06-30T15:59:24.203920Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-06-30T15:59:24.203934Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.203929Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "40ea787f-72de-484d-ac6d-2a24a7730afa",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "c14a15b9-29f6-4da6-a42e-1f42ea4091e5",
- "legacy_id": 282633623,
- "moderated_at": "2025-06-30T15:59:25.587853Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "456522e9-c307-4018-bd97-3ca05bf6c2e6",
- "poll_option_id": "8309ea7d-9aeb-4dec-9b0c-67fd578d785f",
- "reward_claims": [
- {
- "id": "450b9dae-c9f6-4374-9910-031b1f1715d3",
- "quantity": 1,
- "reward_id": "ab892c34-a918-4fc2-a70d-2e2e2593a2a1"
}
], - "reward_id": "fe082716-780e-4e4f-91ce-8f4ad70f3165",
- "sustained": false,
- "target_id": "c467f53d-ea2a-4676-b1ac-56d5d9860c82",
- "team_event_id": "dd32f90d-318f-400f-8e84-f10d7b398dd9",
- "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": "027a8c83-dc5e-4ec7-88e4-f72502bef8ca",
- "description": "My Awesome weekend campaign.",
- "fundraising_event_id": "42da2ccd-8f98-4f2c-9ce1-ffc7d62a27cd",
- "goal": {
- "currency": "USD",
- "value": "182.32"
}, - "has_schedule": false,
- "id": "52280ba8-7639-4ed2-b0a7-48af9141ad86",
- "inserted_at": "2025-06-30T15:59:24.023276Z",
- "legacy_id": 394782949,
- "livestream": {
- "channel": "tiltify",
- "type": "twitch"
}, - "name": "My Awesome Campaign",
- "original_goal": {
- "currency": "USD",
- "value": "182.32"
}, - "parent_facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}
], - "published_at": "2025-06-30T15:59:24.023306Z",
- "retired_at": null,
- "slug": "my-awesome-campaign",
- "status": "published",
- "supporting_type": "none",
- "team_campaign_id": "85ada071-eb80-4812-ab7c-e9bd5bd7a003",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.023312Z",
- "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": "a1b05830-ee42-4f17-87e6-0c7775a5559e",
- "legacy_id": 579952411,
- "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": "05046e9d-79e2-4aa4-acb9-54bd4f66127a"
}
], - "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": "34c450ef-935c-4a7a-b909-0d9fe204d069",
- "inserted_at": "2025-06-30T15:59:23.561378Z",
- "legacy_id": 897906660,
- "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": "2025-06-30T15:59:23.561405Z"
}
}
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": "fad4d063-7ad5-4070-8df4-e8e56b737f4c",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "0653425e-efd8-4ef2-b849-fc4f76868dbf",
- "charity_can_contact": false,
- "completed_at": "2025-06-30T15:59:24.202582Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-06-30T15:59:24.203941Z",
- "donation_id": "287bf125-b190-48b6-a304-32db1f585ccc",
- "ends_at": "2025-06-30T15:59:24.203938Z",
- "id": "0ea69b8a-4bbc-488a-9b3a-c9704f3d241e",
- "inserted_at": "2025-06-30T15:59:24.203920Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-06-30T15:59:24.203934Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.203929Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "40ea787f-72de-484d-ac6d-2a24a7730afa",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "c14a15b9-29f6-4da6-a42e-1f42ea4091e5",
- "legacy_id": 282633623,
- "moderated_at": "2025-06-30T15:59:25.587853Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "456522e9-c307-4018-bd97-3ca05bf6c2e6",
- "poll_option_id": "8309ea7d-9aeb-4dec-9b0c-67fd578d785f",
- "reward_claims": [
- {
- "id": "450b9dae-c9f6-4374-9910-031b1f1715d3",
- "quantity": 1,
- "reward_id": "ab892c34-a918-4fc2-a70d-2e2e2593a2a1"
}
], - "reward_id": "fe082716-780e-4e4f-91ce-8f4ad70f3165",
- "sustained": false,
- "target_id": "c467f53d-ea2a-4676-b1ac-56d5d9860c82",
- "team_event_id": "dd32f90d-318f-400f-8e84-f10d7b398dd9",
- "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": "fad4d063-7ad5-4070-8df4-e8e56b737f4c",
- "campaign_name": "Awesome Test Campaign",
- "cause_id": "0653425e-efd8-4ef2-b849-fc4f76868dbf",
- "charity_can_contact": false,
- "completed_at": "2025-06-30T15:59:24.202582Z",
- "donation_matches": [
- {
- "active": true,
- "amount": {
- "currency": "USD",
- "value": "182.32"
}, - "completed_at": "2025-06-30T15:59:24.203941Z",
- "donation_id": "287bf125-b190-48b6-a304-32db1f585ccc",
- "ends_at": "2025-06-30T15:59:24.203938Z",
- "id": "0ea69b8a-4bbc-488a-9b3a-c9704f3d241e",
- "inserted_at": "2025-06-30T15:59:24.203920Z",
- "matched_by": "Big Donor 1",
- "pledged_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "started_at_amount": {
- "currency": "USD",
- "value": "182.32"
}, - "starts_at": "2025-06-30T15:59:24.203934Z",
- "total_amount_raised": {
- "currency": "USD",
- "value": "182.32"
}, - "updated_at": "2025-06-30T15:59:24.203929Z"
}
], - "donor_comment": "Keep up the great work!",
- "donor_name": "Test Name",
- "email": "donor@tiltify.test",
- "facts": [
- {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Charity",
- "usage_type": "cause"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "Massive Fundraiser",
- "usage_type": "fundraising_event_activation"
}, - {
- "id": "9f7dd842-a64d-4495-a422-d31565b963df",
- "name": "My Campaign",
- "usage_type": "campaign"
}
], - "fundraising_event_id": "40ea787f-72de-484d-ac6d-2a24a7730afa",
- "fundraising_event_name": "Awesome Test Fundraising Event",
- "id": "c14a15b9-29f6-4da6-a42e-1f42ea4091e5",
- "legacy_id": 282633623,
- "moderated_at": "2025-06-30T15:59:25.587853Z",
- "payment_method": "stripe",
- "payment_reference_id": "pi_1234567890",
- "payment_transaction_id": "ch_1234567890",
- "poll_id": "456522e9-c307-4018-bd97-3ca05bf6c2e6",
- "poll_option_id": "8309ea7d-9aeb-4dec-9b0c-67fd578d785f",
- "reward_claims": [
- {
- "id": "450b9dae-c9f6-4374-9910-031b1f1715d3",
- "quantity": 1,
- "reward_id": "ab892c34-a918-4fc2-a70d-2e2e2593a2a1"
}
], - "reward_id": "fe082716-780e-4e4f-91ce-8f4ad70f3165",
- "sustained": false,
- "target_id": "c467f53d-ea2a-4676-b1ac-56d5d9860c82",
- "team_event_id": "dd32f90d-318f-400f-8e84-f10d7b398dd9",
- "team_event_name": "Awesome Test Team Event"
}
], - "metadata": {
- "after": "bGlnaHQgwd==",
- "before": null,
- "limit": 10
}
}