🙋 Supporter

A Supporter is created on the Donations & Fundraising Platform when a donation is made or a fundraising page is created. They will be created with a unique 'supporterId'.

A Supporter will be updated with all of their new donation and fundraising activity.

The following table contains the fields that are returned within the response call of the supporter endpoint.

Key	Label	Type	Description
supporterId	Supporter Id	Long	Supporter ID
charityAccountGuid	Charity Account Guid	UUID	Charity Account GUID
charityId	Charity Id	Long	Charity ID
companyAccountGuid	Company Account Guid	UUID	Company Account GUID
companyId	Company Id	Long	Company ID
firstName	First Name	String	Supporter first name
lastName	Last Name	String	Supporter last name
title	Title	String	Supporter title
email	Email	String	Supporter email
isFund	Is Fund	Boolean	Is supporter a fundraiser
isDonor	Is Donor	Boolean	Is supporter a donor
houseName	House Name	String	House name
address1	Address 1	String	Address line 1
address2	Address 2	String	Address line 2
town	Town	String	Town
postcode	Post Code	String	Postcode
country	Country	String	Country
phone	Phone	String	Phone
billingHouseName	Billing House Name	String	Billing house name
billingAddress1	Billing Address 1	String	Billing address 1
billingAddress2	Billing Address 2	String	Billing address 2
billingTown	Billing Town	String	Billing town
billingPostcode	Billing Postcode	String	Billing postcode
userGuid	User Guid	UUID	User guid
joinDate	Join Date	Date	Join date
lastDonationDate	Last Donation Date	Date	Date of last donation
lifetimeGiftAid	Lifetime Gift Aid	Long	Lifetime gift aid donated
fundraisingTotal	Fundraising Total	Long	Fundraising total
fullName	Full Name	String	Full name
countryCode	Country Code	String	Country code
currencySign	Currency Sign	String	Currency sign
currency	Currency	String	Currency
lastUpdatedDate	Last Updated Date	Date	Date supporter was last updated

🚀 Search Supporters

/supporter

Return a list of supporters filterable by the attributes below

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the supporter
eventIds	Event Ids	Array[Long]	Event Ids associated with the supporter object
date_from	Date From	String	Date from which to filter based on the join date of the supporter
date_to	Date To	String	Date to filter to based on the join date of the supporter
new_supporters_only	New Supporters Only	Boolean	Used in conjunction with date filters, if set to true will filter using join_date, otherwise will use both join_date and lastUpdatedAt (defaults to false)
limit	Limit	Integer	Number of records to be returned in the response
page	Page	Integer	The number of pages to skip before starting to collect the result set

Sample Request

GET - http://dataapi.enthuse.com/supporter?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&campaign_guids=00000000-0000-0000-0000-000000000000
&date_from=2020-02-25%2000%3A00%3A00
&date_to=2020-03-01%2000%3A00%3A00
&limit=25
&page=1

Sample Responses:

200 - OK call was successful and returned data

{
  "address1": "string",
  "address2": "string",
  "billingAddress1": "string",
  "billingAddress2": "string",
  "billingHouseName": "string",
  "billingPostcode": "string",
  "billingTown": "string",
  "charityAccountGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "charityId": 0,
  "companyAccountGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "companyId": 0,
  "country": "string",
  "country_code": "string",
  "currency": "string",
  "currency_sign": "string",
  "email": "string",
  "firstName": "string",
  "full_name": "string",
  "fundraising_total": 0,
  "houseName": "string",
  "isDonor": true,
  "isFund": true,
  "join_date": "2020-01-01 00:00:00",
  "lastName": "string",
  "last_donation_date": "2020-01-01 00:00:00",
  "life_time_gift_aid": 0,
  "phone": "string",
  "postcode": "string",
  "supporterId": 0,
  "title": "string",
  "town": "string",
  "userGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  "lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

416 - Call authenticated but both eventID and campaginGuid used together

{
  "message": "eventId and campaignGuid cannot be used in unison",
  "status": 416
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}

🚀 Get a Supporter

/supporter/{supporter_id}

Get an existing supporter object filterable by a known Supporter ID.

Key	Label	Type	Description
supporter_id	Supporter Id	Long	Supporter Id