### Scope Usage Examples Source: https://developers.tiltify.com/docs/api/authorization/scopes Examples demonstrating how to request multiple scopes. ```APIDOC #### JSON Request Body Example: ```json { "scope": "public webhooks:write" } ``` #### Url Query Param Example: Make sure to url encode the spaces. ``` ?<...>&scope=public%20webhooks%3Awrite ``` ``` -------------------------------- ### Example Verification Headers Source: https://developers.tiltify.com/docs/webhooks/receiving-webhooks/verifying These are example values for the X-Tiltify-Signature and X-Tiltify-Timestamp headers used in webhook verification. ```text X-Tiltify-Signature: 4OSwlhTt0EcrlSQFlqgE18FOtT+EKX4qTJdJeC8oV/o= ``` ```text X-Tiltify-Timestamp: 2023-04-18T16:49:00.617031Z ``` -------------------------------- ### Example Bearer Token Authentication Source: https://developers.tiltify.com/api-reference/public An example of how the Authorization header should be formatted with a specific access token. ```http Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5 ``` -------------------------------- ### Example Webhook Event Source: https://developers.tiltify.com/docs/webhooks/subscriptions/types-of-events An example of a fully formatted webhook event type. ```plaintext public:direct:donation_updated ``` -------------------------------- ### Example cURL Request Source: https://developers.tiltify.com/docs/api/authorization/using-access-tokens This example demonstrates how to make a cURL request to the public campaigns endpoint, including the Authorization header. ```APIDOC ## Example cURL Request ### Description This example shows how to use cURL to fetch campaign data, authenticating with a Bearer token. ### Method GET ### Endpoint `https://v5api.tiltify.com/api/public/campaigns/[campaign_id]` ### Parameters #### Header Parameters - **Authorization** (string) - Required - `Bearer ` ### Request Example ```bash curl https://v5api.tiltify.com/api/public/campaigns/9c3dc859-b0f7-46cb-a496-71f8f94183b8 \ -H 'Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5' ``` ``` -------------------------------- ### Authenticated cURL Request Source: https://developers.tiltify.com/docs/api/authorization/using-access-tokens This example demonstrates how to make an authenticated GET request to retrieve campaign data using cURL. Ensure your Authorization header is correctly formatted with your Bearer token. ```bash curl https://v5api.tiltify.com/api/public/campaigns/9c3dc859-b0f7-46cb-a496-71f8f94183b8 \ -H 'Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5' ``` -------------------------------- ### Example Signature Source: https://developers.tiltify.com/docs/webhooks/receiving-webhooks/verifying This is the base64 encoded signature found in the X-Tiltify-Signature header. ```text 4OSwlhTt0EcrlSQFlqgE18FOtT+EKX4qTJdJeC8oV/o= ``` -------------------------------- ### Example Signed Payload Source: https://developers.tiltify.com/docs/webhooks/receiving-webhooks/verifying This is an example of the signed payload string, combining the timestamp and the raw request body. ```text 2023-04-18T16:49:00.617031Z.{"data":{"amount":{"currency":"USD","value":"82.95"},"campaign_id":"a4fd5207-bd9f-4712-920a-85f8d92cf4e6","completed_at":"2023-04-18T16:48:26.510702Z","created_at":"2023-04-18T03:36:36.510717Z","donor_comment":"Rerum quo necessitatibus voluptas provident ad molestiae ipsam.","donor_name":"Jirachi","fundraising_event_id":null,"id":"dfa25dcc-2026-4320-a5b7-5da076efeb05","legacy_id":0,"poll_id":null,"poll_option_id":null,"reward_id":null,"sustained":false,"target_id":null,"team_event_id":null},"meta":{"attempted_at":"2023-04-18T16:49:00.617031Z","event_type":"public:direct:donation_updated","generated_at":"2023-04-18T16:48:59.510758Z","id":"d8768e26-1092-4f4c-a829-a2698cd19664","subscription_source_id":"00000000-0000-0000-0000-000000000000","subscription_source_type":"test"}} ``` -------------------------------- ### Example Timestamp Source: https://developers.tiltify.com/docs/webhooks/receiving-webhooks/verifying This is the ISO-8601 encoded timestamp found in the X-Tiltify-Timestamp header. It should be recent to the current timestamp. ```text 2023-04-18T16:49:00.617031Z ``` -------------------------------- ### Get auction item details Source: https://developers.tiltify.com/api-reference/public Retrieves detailed information about a specific auction item, including its name, description, start and end times, and bidding information. ```APIDOC ## GET /api/public/auction_houses/{auction_house_id}/auction_items/{auction_item_id} ### Description Retrieves details for a specific auction item. ### Method GET ### Endpoint https://v5api.tiltify.com/api/public/auction_houses/{auction_house_id}/auction_items/{auction_item_id} ### Parameters #### Path Parameters - **auction_house_id** (string) - Required - Auction House ID - **auction_item_id** (string) - Required - Auction Item ID ### Responses #### Success Response (200) - **data** (object) - Details of the auction item. #### Response Example ```json { "data": { "activated_at": "2026-04-22T17:20:11.430100Z", "completed_at": "2026-04-22T17:20:11.430113Z", "description": "My Awesome weekend auction item.", "ends_at": "2026-04-22T17:20:11.430115Z", "fair_market_value": { "currency": "USD", "value": "182.32" }, "id": "b63c23e0-76c0-4d00-92e7-48a391bd539d", "images": [ { "alt": "Short image description used as alternative text.", "height": 200, "src": "https://tiltify.com/images/example.jpg", "width": 200 } ], "inserted_at": "2026-04-22T17:20:12.319473Z", "legal": "This is a legal disclaimer.", "name": "My Awesome Auction Item", "rules": "To bid you must be in the USA.", "short_description": "short auction item.", "starting_bid": { "currency": "USD", "value": "182.32" }, "starts_at": "2026-04-22T17:20:12.319483Z", "status": "active" } } ``` ``` -------------------------------- ### Create a Relay Key with Tiltify API (cURL) Source: https://developers.tiltify.com/docs/webhooks/relays/using-relays Use this cURL command to create a Relay Key. Ensure you have an Application Access Token with the 'webhooks:write' scope. The 'id' and 'metadata' fields are optional for tracking. ```bash curl -X POST https://v5api.tiltify.com/api/private/webhook_relays/8e615ce4-9246-42d3-b3b2-b3fba2b55d2a/webhook_relay_keys \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ab6a592346444dea97170837e104d8a5ab6a592346444dea97170837e104d8a5' \ -d '{"id":"internal_2OyjGiv8ODkZqhvjmA0vmsY49JT","metadata":"eyJjdXN0b20iOiJtZXRhZGF0YSJ9"}' ``` -------------------------------- ### cURL Request for Application Access Token Source: https://developers.tiltify.com/docs/api/authorization/client-credentials Example cURL command to request an Application Access Token. Replace placeholders with your actual client ID, client secret, and desired scope. ```bash curl -X POST https://v5api.tiltify.com/oauth/token \ -H 'Content-Type: application/json' \ -d '{"client_id":"e98e79be37f830026564ed5c190e01200c3f8f1707c4af36993c974e461dc64d","client_secret":"9e255194d71ab8594e665af33eb207e91cf122a00573b92d0f1965e0e4588f45", "grant_type": "client_credentials", "scope": "public"}' ``` -------------------------------- ### Example Donation Updated Payload Source: https://developers.tiltify.com/docs/webhooks/relays/using-relays This is an example of the JSON payload received when a donation is updated via a relay. It includes details about the donation and metadata about the relay event. ```json { "data": { "amount": { "currency": "USD", "value": "20.00" }, "campaign_id": "2d4f019a-4e0e-491f-86e2-03f59e80d921", "cause_id": "1071561f-54ef-4c4f-a7ed-f9a4536eb5be", "completed_at": "2023-05-12T00:46:18.493622Z", "created_at": "2023-05-11T11:45:41.495861Z", "donor_comment": "Odit non et dignissimos consequatur aut qui sequi.", "donor_name": "Ledian", "fundraising_event_id": null, "id": "b5cbe2d5-4907-459c-8941-5330122d3fca", "legacy_id": 123456, "poll_id": null, "poll_option_id": null, "reward_id": null, "sustained": false, "target_id": null, "team_event_id": null }, "meta": { "attempted_at": "2023-05-12T00:45:27.832161Z", "event_type": "private:relay:donation_updated", "generated_at": "2023-05-12T00:45:27.775534Z", "id": "960a8f5a-1103-4234-83b3-e281b92126fc", "relay_id": "8e615ce4-9246-42d3-b3b2-b3fba2b55d2a", "relay_key_id": "internal_2OyjGiv8ODkZqhvjmA0vmsY49JT", "relay_metadata": "eyJjdXN0b20iOiJtZXRhZGF0YSJ9" } } ``` -------------------------------- ### Example Webhook JSON Request Body Source: https://developers.tiltify.com/docs/webhooks/receiving-webhooks This is an example of the JSON payload sent with a Tiltify webhook POST request. It contains details about the event, such as donation information. ```json {"data":{"amount":{"currency":"USD","value":"25.94"},"campaign_id":"05abe59b-0301-4eaf-89c2-92015103f1cb","completed_at":"2023-04-18T16:11:58.484907Z","created_at":"2023-04-18T01:51:44.484923Z","donor_comment":"Exercitationem est quaerat voluptatem explicabo minus!","donor_name":"Wynaut","fundraising_event_id":null,"id":"386bb6d5-8b7f-464e-a095-ea0057f08635","legacy_id":0,"poll_id":null,"poll_option_id":null,"reward_id":null,"sustained":false,"target_id":null,"team_event_id":"20fbee79-327b-4604-858c-4f77cdbf5ab3"},"meta":{"attempted_at":"2023-04-18T16:12:16.688821Z","event_type":"public:direct:donation_updated","generated_at":"2023-04-18T16:12:15.484965Z","id":"8b91dd75-98b6-4d60-8c62-a74645adbca6","subscription_source_id":"00000000-0000-0000-0000-000000000000","subscription_source_type":"test"}} ``` -------------------------------- ### URL Query Parameter Example for Multiple Scopes Source: https://developers.tiltify.com/docs/api/authorization/scopes When requesting access via URL query parameters, ensure spaces between scopes are URL encoded. ```url ?<...>&scope=public%20webhooks%3Awrite ``` -------------------------------- ### Successful Relay Key Creation Response Source: https://developers.tiltify.com/docs/webhooks/relays/using-relays This is an example of a successful response when creating a Relay Key. The 'client_key' is crucial for redirecting users. ```json { "data": %{ "client_key": "dc6e53fd4dce7d9f9509618367f8aa67eba8e14dda94c9d9d2e418318784fcbd", "donation": null, "id": "internal_2OyjGiv8ODkZqhvjmA0vmsY49JT", "inserted_at": "2023-05-12T00:41:51.412985Z", "metadata": "eyJjdXN0b20iOiJtZXRhZGF0YSJ9", "updated_at": "2023-05-12T00:41:51.412985Z", "webhook_relay_id": "8e615ce4-9246-42d3-b3b2-b3fba2b55d2a" } } ``` -------------------------------- ### Get the currently cause Source: https://developers.tiltify.com/api-reference/cause Returns the current cause details. ```APIDOC ## GET /api/cause/current ### Description Returns the current cause details. ### Method GET ### Endpoint https://v5api.tiltify.com/api/cause/current ### Responses #### Success Response (200) - **data** (array) - An array of cause objects. - **amount_raised** (object) - The total amount raised for the cause. - **currency** (string) - The currency of the amount raised. - **value** (string) - The value of the amount raised. - **avatar** (object) - Information about the cause's avatar. - **alt** (string) - Alternative text for the avatar image. - **height** (integer) - The height of the avatar image. - **src** (string) - The URL of the avatar image. - **width** (integer) - The width of the avatar image. - **cause_id** (string) - The unique identifier for the cause. - **description** (string) - A description of the cause. - **directed_funds** (object) - Information about funds directed to a specific region. - **code** (string) - The country code for directed funds. - **name** (string) - The name of the country for directed funds. - **donate_url** (string) - The URL to donate to the cause. - **fundraising_event_id** (string) - The ID of the associated fundraising event. - **goal** (object) - The fundraising goal for the cause. - **currency** (string) - The currency of the goal. - **value** (string) - The value of the goal. - **has_schedule** (boolean) - Indicates if the cause has a schedule. - **id** (string) - The unique identifier for the cause. - **inserted_at** (string) - The timestamp when the cause was created. - **legacy_id** (integer) - The legacy ID of the cause. - **livestream** (object) - Information about the associated livestream. - **channel** (string) - The livestream channel name. - **type** (string) - The type of livestream platform. - **membership_donation** (object) - Details about membership donations. - **amount** (object) - The amount of the membership donation. - **currency** (string) - The currency of the donation amount. - **value** (string) - The value of the donation amount. - **status** (string) - The status of the membership donation. - **name** (string) - The name of the cause. - **original_goal** (object) - The original fundraising goal for the cause. - **currency** (string) - The currency of the original goal. - **value** (string) - The value of the original goal. - **parent_facts** (array) - Information about parent entities related to the cause. - **id** (string) - The ID of the parent entity. - **name** (string) - The name of the parent entity. - **usage_type** (string) - The type of usage for the parent entity. - **published_at** (string) - The timestamp when the cause was published. - **retired_at** (null) - The timestamp when the cause was retired (if applicable). - **slug** (string) - The slug for the cause URL. - **status** (string) - The current status of the cause. - **supporting_type** (string) - The type of support for the cause. - **team_campaign_id** (string) - The ID of the associated team campaign. - **team_owner** (object) - Information about the owner of the team campaign. - **avatar** (object) - Information about the team owner's avatar. - **alt** (string) - Alternative text for the avatar image. - **height** (integer) - The height of the avatar image. - **src** (string) - The URL of the avatar image. - **width** (integer) - The width of the avatar image. - **description** (string) - A description of the team owner. - **email** (string) - The email address of the team owner. - **id** (string) - The unique identifier for the team owner. - **legacy_id** (integer) - The legacy ID of the team owner. - **slug** (string) - The slug for the team owner's profile URL. - **social** (object) - Social media links for the team owner. - **discord** (string) - Discord profile URL. - **facebook** (string) - Facebook profile URL. - **instagram** (string) - Instagram profile URL. - **snapchat** (string) - Snapchat profile URL. - **tiktok** (string) - TikTok profile URL. - **twitch** (string) - Twitch profile URL. - **twitter** (string) - Twitter profile URL. - **website** (string) - Website URL. - **youtube** (string) - YouTube channel URL. - **total_amount_raised** (object) - The total amount raised by the team owner. - **currency** (string) - The currency of the total amount raised. - **value** (string) - The value of the total amount raised. - **url** (string) - The URL of the team owner's profile. - **username** (string) - The username of the team owner. - **total_amount_raised** (object) - The total amount raised for the cause. - **currency** (string) - The currency of the total amount raised. - **value** (string) - The value of the total amount raised. - **updated_at** (string) - The timestamp when the cause was last updated. - **url** (string) - The URL of the cause. - **user** (object) - Information about the user associated with the cause. - **avatar** (object) - Information about the user's avatar. - **alt** (string) - Alternative text for the avatar image. - **height** (integer) - The height of the avatar image. - **src** (string) - The URL of the avatar image. - **width** (integer) - The width of the avatar image. - **description** (string) - A description of the user. - **email** (string) - The email address of the user. - **id** (string) - The unique identifier for the user. - **legacy_id** (integer) - The legacy ID of the user. - **slug** (string) - The slug for the user's profile URL. - **social** (object) - Social media links for the user. - **discord** (string) - Discord profile URL. - **facebook** (string) - Facebook profile URL. - **instagram** (string) - Instagram profile URL. - **snapchat** (string) - Snapchat profile URL. - **tiktok** (string) - TikTok profile URL. - **twitch** (string) - Twitch profile URL. - **twitter** (string) - Twitter profile URL. - **website** (string) - Website URL. - **youtube** (string) - YouTube channel URL. - **total_amount_raised** (object) - The total amount raised by the user. - **currency** (string) - The currency of the total amount raised. - **value** (string) - The value of the total amount raised. - **url** (string) - The URL of the user's profile. - **username** (string) - The username of the user. - **user_id** (string) - The unique identifier for the user associated with the cause. - **metadata** (object) - Metadata for pagination. - **after** (string) - Cursor for the next page. - **before** (null) - Cursor for the previous page. - **limit** (integer) - The number of items per page. #### Error Response (401) Unauthorized #### Error Response (404) Not Found #### Error Response (422) Unprocessable Entity ``` -------------------------------- ### Get by ID Source: https://developers.tiltify.com/api-reference/public Retrieves a specific cause by its unique ID. ```APIDOC ## Get by ID ### Description Returns a cause by its ID ### Method GET ### Endpoint /api/public/causes/{cause_id} ### Parameters #### Path Parameters - **cause_id** (string) - Required - Cause ID ### Responses #### Success Response (200) - **data** (object) - Contains the cause details. #### Response Example ```json { "data": { "avatar": { "alt": "Short image description used as alternative text.", "height": 200, "src": "https://tiltify.com/images/example.jpg", "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": "96e7a6af-257a-48e0-bd14-29f283e6e5c7", "inserted_at": "2026-04-22T17:20:11.961202Z", "legacy_id": 163197447, "name": "Ewok Rescue Foundation", "short_description": "ERF works in Endor to protect the Ewoks", "slug": "ewok-rescue-foundation", "social": { "discord": "https://discord.gg/tiltify", "facebook": "tiltify", "instagram": "tiltify", "snapchat": "tiltify", "tiktok": "tilitfy", "twitch": "tilitfy", "twitter": "tiltify", "website": "https://tiltify.com", "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw" }, "updated_at": "2026-04-22T17:20:11.964761Z" } } ``` ``` -------------------------------- ### Authorization Request URL with URL Encoding Source: https://developers.tiltify.com/docs/api/authorization/authorization-code Example of a fully formed authorization request URL, demonstrating necessary URL encoding for parameters like redirect_uri and scope. ```url https://v5api.tiltify.com/oauth/authorize ?response_type=code &client_id=21ce85473de11b0abac192f354330284032ab4755925b58361dc08a4c34f62c7 &redirect_uri=http%3A%2F%2Flocalhost%3A9000 &scope=public ``` -------------------------------- ### Response Sample for User Leaderboard Source: https://developers.tiltify.com/api-reference/cause This is a sample JSON response for a user leaderboard. It includes details about current values, distance units, and goals. ```json { "data": [ { "current_value": "44.4", "distance_unit": "mile", "goal": "1000", "id": "59d471c6-7dce-4123-b247-fc6971f2dc1a", "type": "Running" } ], "metadata": { "after": "bGlnaHQgwd==", "before": null, "limit": 10 } } ``` -------------------------------- ### Get by ID Source: https://developers.tiltify.com/api-reference/public Returns an auction house by its ID. Requires authorization. ```APIDOC ## Get by ID ### Description Returns an auction house by its ID. ### Method GET ### Endpoint /api/public/auction_houses/{auction_house_id} ### Parameters #### Path Parameters - **auction_house_id** (string) - Required - Auction House ID ### Responses #### Success Response (200) - **Response** (object) - Contains the auction house details. #### Error Responses - **401** - Unauthorized - **404** - Not Found - **422** - Unprocessable Entity ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Team Campaign by ID Source: https://developers.tiltify.com/api-reference/public Retrieves a specific team campaign by its ID. ```APIDOC ## GET /api/public/team_campaigns/{team_campaign_id} ### Description Returns a Team Campaign by its ID. ### Method GET ### Endpoint https://v5api.tiltify.com/api/public/team_campaigns/{team_campaign_id} ### Parameters #### Path Parameters - **team_campaign_id** (string) - Required - Team Campaign ID ### Responses #### Success Response (200) [Response details not provided in source] #### Error Responses - **401** Unauthorized - **404** Not Found - **422** Unprocessable Entity ``` -------------------------------- ### Request Authorization Source: https://developers.tiltify.com/docs/api/authorization/authorization-code Initiate the OAuth flow by redirecting the user to the Tiltify authorization URL with the necessary query parameters. ```APIDOC ## Request Authorization ### Description Send the user in a browser to the Tiltify OAuth Authorization URL, including the following required and optional query parameters. ### Parameters #### Query Parameters - **client_id** (string) - Required - The Client ID of your OAuth Application. - **response_type** (string) - Required - The string "code". - **redirect_uri** (string) - Required - Your Application's configured redirect URI. Must be URL encoded. - **scope** (string) - Optional - A string of scopes. See supported scopes. Must be URL encoded. ### Example ``` https://v5api.tiltify.com/oauth/authorize?client_id=&response_type=code&redirect_uri=&scope= ``` #### Example with values and URL encoding: ``` https://v5api.tiltify.com/oauth/authorize?response_type=code&client_id=21ce85473de11b0abac192f354330284032ab4755925b58361dc08a4c34f62c7&redirect_uri=http%3A%2F%2Flocalhost%3A9000&scope=public ``` ``` -------------------------------- ### Get Donation by ID Source: https://developers.tiltify.com/api-reference/cause Retrieves a specific donation using its unique identifier. ```APIDOC ## GET /api/cause/donations/{donation_id} ### Description Returns a donation by its ID. ### Method GET ### Endpoint https://v5api.tiltify.com/api/cause/donations/{donation_id} ### Parameters #### Path Parameters - **donation_id** (string) - Required - Donation ID ### Responses #### Success Response (200) - **data** (object) - Contains the donation details. - **avatar** (object) - **alt** (string) - Short image description used as alternative text. - **height** (integer) - Image height. - **src** (string) - Image source URL. - **width** (integer) - Image width. - **contact** (object) - **address_line1** (string) - First line of the address. - **address_line2** (string) - Second line of the address (nullable). - **city** (string) - City name. - **country** (string) - Country name. - **email** (string) - Contact email address. - **postal_code** (string) - Postal code. - **region** (string) - State or region. - **currency_code** (string) - The currency code for the donation (e.g., USD). - **description** (string) - A detailed description of the cause. - **government_id** (string) - The government-issued ID of the cause. - **id** (string) - The unique identifier for the cause. - **inserted_at** (string) - The timestamp when the cause was created (ISO 8601 format). - **legacy_id** (integer) - The legacy ID of the cause. - **name** (string) - The name of the cause. - **short_description** (string) - A brief description of the cause. - **slug** (string) - A URL-friendly identifier for the cause. - **social** (object) - **discord** (string) - Discord profile URL. - **facebook** (string) - Facebook profile URL or username. - **instagram** (string) - Instagram profile URL or username. - **snapchat** (string) - Snapchat profile URL or username. - **tiktok** (string) - TikTok profile URL or username. - **twitch** (string) - Twitch profile URL or username. - **twitter** (string) - Twitter profile URL or username. - **website** (string) - Website URL. - **youtube** (string) - YouTube channel URL. - **status** (string) - The current status of the cause (e.g., 'published'). - **updated_at** (string) - The timestamp when the cause was last updated (ISO 8601 format). #### Response Example ```json { "data": { "avatar": { "alt": "Short image description used as alternative text.", "height": 200, "src": "https://tiltify.com/images/example.jpg", "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": "96e7a6af-257a-48e0-bd14-29f283e6e5c7", "inserted_at": "2026-04-22T17:20:11.961202Z", "legacy_id": 163197447, "name": "Ewok Rescue Foundation", "short_description": "ERF works in Endor to protect the Ewoks", "slug": "ewok-rescue-foundation", "social": { "discord": "https://discord.gg/tiltify", "facebook": "tiltify", "instagram": "tiltify", "snapchat": "tiltify", "tiktok": "tilitfy", "twitch": "tilitfy", "twitter": "tiltify", "website": "https://tiltify.com", "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw" }, "status": "published", "updated_at": "2026-04-22T17:20:11.964761Z" } } ``` #### Error Responses - **401** Unauthorized - **404** Not Found - **422** Unprocessable Entity ``` -------------------------------- ### Get User Teams Source: https://developers.tiltify.com/api-reference/public Retrieves a list of teams associated with a specific user ID. ```APIDOC ## GET /api/public/users/{user_id}/teams ### Description Retrieves a list of teams associated with a specific user ID. ### Method GET ### Endpoint /api/public/users/{user_id}/teams ### Parameters #### Path Parameters - **user_id** (string) - Required - The unique identifier of the user. ### Response #### Success Response (200) - **data** (array) - An array of team objects. - **avatar** (object) - Information about the team's avatar. - **alt** (string) - Alternative text for the avatar image. - **height** (integer) - The height of the avatar image. - **src** (string) - The URL of the avatar image. - **width** (integer) - The width of the avatar image. - **description** (string) - A description of the team. - **id** (string) - The unique identifier of the team. - **legacy_id** (integer) - The legacy identifier of the team. - **name** (string) - The name of the team. - **slug** (string) - The slugified name of the team. - **social** (object) - Social media links for the team. - **discord** (string) - Discord link. - **facebook** (string) - Facebook link. - **instagram** (string) - Instagram link. - **snapchat** (string) - Snapchat link. - **tiktok** (string) - TikTok link. - **twitch** (string) - Twitch link. - **twitter** (string) - Twitter link. - **website** (string) - Website link. - **youtube** (string) - YouTube link. - **total_amount_raised** (object) - The total amount raised by the team. - **currency** (string) - The currency of the amount raised. - **value** (string) - The value of the amount raised. - **url** (string) - The URL of the team's page on Tiltify. - **metadata** (object) - Metadata for the response. - **after** (string) - Cursor for the next page of results. - **before** (string) - Cursor for the previous page of results. - **limit** (integer) - The number of items per page. #### Response Example ```json { "data": [ { "avatar": { "alt": "Short image description used as alternative text.", "height": 200, "src": "https://tiltify.com/images/example.jpg", "width": 200 }, "description": "Awesome group of friends fundraising for charity together.", "id": "82bbb194-1c0a-4307-adc4-5b7df9a47e9d", "legacy_id": 296341860, "name": "Awesome Team", "slug": "awesome-team", "social": { "discord": "https://discord.gg/tiltify", "facebook": "tiltify", "instagram": "tiltify", "snapchat": "tiltify", "tiktok": "tilitfy", "twitch": "tilitfy", "twitter": "tiltify", "website": "https://tiltify.com", "youtube": "UCWcPgWbuWuJX5rHWm6Kb4Vw" }, "total_amount_raised": { "currency": "USD", "value": "182.32" }, "url": "https://tiltify.com/+awesome-team" } ], "metadata": { "after": "bGlnaHQgwd==", "before": null, "limit": 10 } } ``` ``` -------------------------------- ### Example Webhook HTTP Headers Source: https://developers.tiltify.com/docs/webhooks/receiving-webhooks These headers are included in POST requests from Tiltify. Ensure your endpoint can parse and validate them, especially the signature. ```text Content-Type: application/json User-Agent: Tiltify Outgoing Webhook X-Tiltify-Timestamp: 2023-04-18T16:06:55.323352Z X-Tiltify-Signature: FmbJdukjOp0XnyjRm0eFeG7A2SO4q8u0xZjsy36ZTzA= X-Tiltify-Verision: v5 X-Tiltify-Endpoint: 7a03496d-2f03-4b7c-9f2e-6117ca62bb6e ``` -------------------------------- ### Activate Webhook Endpoint Response Sample Source: https://developers.tiltify.com/api-reference/private This JSON sample represents a successful activation of a webhook endpoint. It confirms the activation timestamp and the status of the endpoint. ```json { "activated_at": "2026-04-22T17:20:11.481294Z", "deactivated_at": null, "description": "My Webhook Endpoint for Tiltify Fundraisers.", "id": "5e9af487-3c29-4fb8-af72-e815f956a03f", "inserted_at": "2026-04-22T17:20:11.481325Z", "status": "active", "updated_at": "2026-04-22T17:20:11.481327Z", "url": "https://webhooks.tiltify.test/endpoint" } ```