📆 Fundraising Event Use Cases
Examples of how to use the Enthuse API to get information on your Fundraising Events
This document will explain some common examples of using the Enthuse API when pulling back data related to Fundraising Events.
A Fundraising Event represents the event that has been set up by a charity or corporate account that your supporters can register for in order to fundraise and raise donations. This includes events set up on our Fundraising platform and our Events platform with fundraising enabled. These events will be set up with a unique 'eventPageId'.
Example of details from a fundraising event can be retrieved from the following endpoints:
- Returns a list of event fundraising pages /eventFundraisingPage
- Returns an event fundraising page /eventFundraisingPage/{event_page_id}
Example JSON response from the above endpoint
{
"status": 200,
"eventFundraisingPageList": [
{
"createdDate": "2023-01-01 00:00:01",
"lastUpdatedAt": "2023-01-01 00:00:01",
"eventTitle": "My Test Event",
"companyId": 0,
"charityId": 1234,
"target": 250.00,
"status": "0",
"eventUrl": "https://demo-charity.enthuse-sandbox.com/cf/mytestevent",
"eventPageId": 123,
"campaignGuid": "00000000-0000-0000-0000-000000000000",
"charityAccountGuid": "00000000-0000-0000-0000-000000000000",
"companyAccountGuid": null
}
]
}❓ How can I get all of the fundraising pages created for a fundraising event?
Given you have details on a particular fundraising event, you will be able to to retrieve all the fundraising pages created for that event by calling the following /personalFundraisingPage endpoint and passing in the 'eventPageId' of the particular event that you want to retrieve details for.
This endpoint would return a list of personal fundraising pages linked to that event.
Example JSON response from the above endpoint
{
"status": 200,
"personalFundraisingPageList": [
{
"createdDate": "2023-01-02 16:00:09",
"liveDate": "2023-01-02 16:00:09",
"lastUpdatedAt": "2023-01-02 16:00:09",
"supporterId": 1,
"companyId": 0,
"charityId": 1234,
"charityAccountGuid": "00000000-0000-0000-0000-000000000000",
"companyAccountGuid": null,
"campaignGuid": "00000000-0000-0000-0000-000000000000",
"displayName": "John Smith",
"title": "My Test Event",
"raisedAmount": 0.0,
"totalOfflineDonations": 0.0,
"giftAidRaised": 0.0,
"pageUrl": "https://demo-company.enthuse-sandbox.com/cf/johnsmith",
"pfId": 1000,
"teamId": 0,
"eventPageId": 123,
"target": 250.0,
"status": "0"
},
{
"createdDate": "2023-01-02 16:00:09",
"liveDate": "2023-01-02 16:00:09",
"lastUpdatedAt": "2023-01-02 16:00:09",
"supporterId": 2,
"companyId": 0,
"charityId": 1234,
"charityAccountGuid": "37c4991a-a3f7-4ece-a81b-0ccfcca7870f",
"companyAccountGuid": null,
"campaignGuid": "37c4991a-a3f7-4ece-a81b-0ccfcca7870a",
"displayName": "Jane Smith",
"title": "My Test Event",
"raisedAmount": 0.0,
"totalOfflineDonations": 0.0,
"giftAidRaised": 0.0,
"pageUrl": "https://demo-company.enthuse-sandbox.com/cf/janesmith",
"pfId": 1001,
"teamId": 0,
"eventPageId": 123,
"target": 450.0,
"status": "0"
}
]
}❓How can I get all of the registrants for a fundraising event?
Given you have details on a particular fundraising event page and it is linked to a registration event,
you will be able to retrieve all the registrants for the event through the use of the campaignGuid.
For example if you have an event with PageId of 1234, you would need to call /eventFundraisingPage/{event_page_id}
passing in the 1234 as the event_page_id
resulting in payload like below:
{
"createdDate": "2022-08-16 13:44:52",
"lastUpdatedAt": "2022-08-16 13:44:55",
"eventTitle": "Test Event Page",
"companyId": 0,
"charityId": 319814,
"target": 25,
"status": "0",
"eventUrl": "https://test.enthuse-test.com/cf/test-event-page",
"eventPageId": 1234,
"campaignGuid": "5c98a518-8ch9-d4f1-p68s-3e5421b0e1z0",
"charityAccountGuid": "37c4991a-a3f7-4ece-a81b-5c98a518",
"companyAccountGuid": null
}You can then use the '"campaignGuid": "5c98a518-8ch9-d4f1-p68s-3e5421b0e1z0",' as a parameter in the call /registrations
This endpoint would return a list of registrations linked to that events campaign guid.
Example JSON response from the above endpoint below:
{
"status": 200,
"registrationList": [
{
"registration_guid": "00000000-0000-0000-0000-000000000000",
"fitness_guid": "00000000-0000-0000-0000-000000000000",
"fitness_settings_guid": "00000000-0000-0000-0000-000000000000",
"campaignGuid": "5c98a518-8ch9-d4f1-p68s-3e5421b0e1z0",
"account_guid": "00000000-0000-0000-0000-000000000000",
"payment_guid": "00000000-0000-0000-0000-000000000000",
"fundraising_guid": "00000000-0000-0000-0000-000000000000",
"registration_date": "2023-01-02 16:00:09",
"changed_at": "2023-01-02 16:00:09",
"order_id": 1,
"event_guid": "00000000-0000-0000-0000-000000000000",
"status": "COMPLETED",
"manage_my_reg_url":" ",
"event_name": "My Test Event",
"primary": true,
"method": "ONLINE",
"discount_id": null,
"discount_code": null,
"first_name": "John",
"last_name": "Smith",
"dob": "1994-03-03",
"gender": "M",
"email": "[email protected]",
"phone": "+4470000000",
"address_line_one": "123 Buckingham Palace Road",
"address_line_two": "",
"city": "London",
"county": "London",
"country": "United Kingdom",
"post_code": "SW1W 0QP",
"payment": null,
"questions": null,
"ticket": {
"ticket_id": 1242,
"ticket_name": "Test Fee",
"ticket_type": "INDIVIDUAL",
"price": 10.0,
"service_fee": 0.0,
"description": "Test description"
},
"team": null,
"donation": {
"donation_id": null,
"donation_amount": null
},
"fundraising": {
"campaign_guid": "00000000-0000-0000-0000-000000000000",
"page_id": 1000
},
"merchandise": null,
"meta_data": null
},
{
"registration_guid": "00000000-0000-0000-0000-000000000000",
"fitness_guid": "00000000-0000-0000-0000-000000000000",
"fitness_settings_guid": "00000000-0000-0000-0000-000000000000",
"campaignGuid": "5c98a518-8ch9-d4f1-p68s-3e5421b0e1z0",
"account_guid": "00000000-0000-0000-0000-000000000000",
"payment_guid": "00000000-0000-0000-0000-000000000000",
"fundraising_guid": "00000000-0000-0000-0000-000000000000",
"registration_date": "2023-01-02 16:00:09",
"changed_at": "2023-01-02 16:00:09",
"order_id": 2,
"event_guid": "00000000-0000-0000-0000-000000000000",
"status": "COMPLETED",
"manage_my_reg_url": "http://localhost:8080/ps/AutoLogin?orderId=MjQwMTQ0Ng%3D%3D&entryId=NTg1MzAzNA%3D%3D",
"event_name": "My Test Event",
"primary": true,
"method": "ONLINE",
"discount_id": null,
"discount_code": null,
"first_name": "Jane",
"last_name": "Smith",
"dob": "2018-05-04",
"gender": "F",
"email": "[email protected]",
"phone": "+447000000",
"address_line_one": "123 Buckingham Palace Road",
"address_line_two": null,
"city": "London",
"county": "",
"country": "United Kingdom",
"post_code": "SW1W 0QP",
"payment": null,
"questions": null,
"ticket": {
"ticket_id": 1242,
"ticket_name": "Test Fee",
"ticket_type": "INDIVIDUAL",
"price": 10.0,
"service_fee": 0.0,
"description": "Test description"
},
"team": null,
"donation": {
"donation_id": null,
"donation_amount": null
},
"fundraising": {
"campaign_guid": "00000000-0000-0000-0000-000000000000",
"page_id": 1001
},
"merchandise": null,
"meta_data": null
}
]
}❓How can I get all of the supporters for a fundraising event?
Given you have details on a particular fundraising event, you will be able to retrieve all the supporters for the event by calling the following /supporter endpoint and passing in the 'eventPageId' of the particular event that you want to retrieve the supporters from.
This endpoint would return a list of supporters linked to that event
Example JSON response from the above endpoint
{
"status": 200,
"supporterPojoList": [
{
"supporterId": 1,
"charityAccountGuid": "00000000-0000-0000-0000-000000000000",
"charityId": 1234,
"companyAccountGuid": null,
"companyId": 0,
"firstName": "John",
"lastName": "Smith",
"title": "Mr",
"email": "[email protected]",
"isFund": true,
"isDonor": false,
"houseName": null,
"address1": "123 Buckingham Palace Road",
"address2": null,
"town": "London",
"postcode": "SW1W 0QP",
"country": "United Kingdom",
"phone": "+447000000",
"billingHouseName": null,
"billingAddress1": "123 Buckingham Palace Road",
"billingAddress2": null,
"billingTown": "London",
"billingPostcode": "SW1W 0QP",
"userGuid": "00000000-0000-0000-0000-000000000000",
"join_date": "2023-01-02 16:00:09",
"last_donation_date": "2023-01-02 16:00:09",
"life_time_gift_aid": 0.0,
"fundraising_total": 0.0,
"full_name": "John Smith",
"country_code": "GB",
"currency_sign": "£",
"currency": "GBP",
"last_updated_at": "2023-01-02 16:00:09"
},
{
"supporterId": 2,
"charityAccountGuid": "00000000-0000-0000-0000-000000000000",
"charityId": 1234,
"companyAccountGuid": null,
"companyId": 0,
"firstName": "Jane",
"lastName": "Smith",
"title": "Mrs",
"email": "[email protected]",
"isFund": true,
"isDonor": true,
"houseName": null",
"address1": "123 Buckingham Palace Road",
"address2": null",
"town": "London",
"postcode": "SW1W 0QP",
"country": "United Kingdom",
"phone": "+447000000",
"billingHouseName": null,
"billingAddress1": "123 Buckingham Palace Road",
"billingAddress2": null,
"billingTown": "London",
"billingPostcode": "SW1W 0QP",
"userGuid": "00000000-0000-0000-0000-000000000000",
"join_date": "2023-01-02 16:00:09",
"last_donation_date": "2023-01-02 16:00:09",
"life_time_gift_aid": 0.0,
"fundraising_total": 0.0,
"full_name": "Jane Smith",
"country_code": "GB",
"currency_sign": "£",
"currency": "GBP",
"last_updated_at": "2023-01-02 16:00:09"
}
]
}❓How can I get all of the payments for a fundraising event?
You will not be able to filter payments on a specific Fundraising Event, however if you call the payments /payments endpoint then the payments' 'fundraise_event_page_id' will match the 'eventPageId' of your Fundraising Event.
Example JSON response from the above endpoint
{
"status": 200,
"paymentList": [
{
"payment_transaction_guid": "00000000-0000-0000-0000-000000000000",
"charity_account_guid": "00000000-0000-0000-0000-000000000000",
"company_account_guid": null,
"shared_campaign_guid": "00000000-0000-0000-0000-000000000000",
"registrations_event_id": 12345,
"registrations_order_id": 12345,
"fundraise_event_page_id": 12345,
"fundraise_checkout_id": null,
"fundraise_payment_id": null,
"payment_method_reference": "ch_2MOfvS6OMZXeloA6036OMgGE",
"payment_system": "Stripe",
"first_name": "FirstName",
"last_name": "LastName",
"transaction_type": "Payment",
"product_type": "EventRegistration",
"payment_date": "2023-01-10 11:23:46",
"fundraise_page_or_team_page_ids": [
1234
],
"payment_type": "Ticket",
"currency": "GBP",
"platform_fee": 1.49,
"gift_aid_fee": 0,
"service_fee": 1.1,
"payment_provider_fee": 0,
"amount_without_fees": 8.51,
"amount_with_fees": 10,
"gift_aid_amount": 0,
"donor_fee_covered_amount": 0,
"fee_model": "PayAsYouGo",
"is_submitted_to_hmrc_status": false,
"fundraise_schedule_id": 0,
"parent_payment_transaction_guid": null,
"title": null,
"house_name": null,
"address_line_1": "Address",
"address_line_2": "",
"town": "Town",
"post_code": "SW1A 1AA",
"country_code": "GB",
"supporter_id": 12345,
"is_guest": false,
"is_anonymous": false,
"donation_message": null,
"email": "[email protected]",
"checkoutReferenceCode": null,
"purchaseInformation": null
},
{
"payment_transaction_guid": "00000000-0000-0000-0000-000000000000",
....If you have a payment, you can find out which fundraising event the payment is linked to. Please see the Payment Uses Cases for more information.
Updated about 2 months ago