👪 Team Fundraising Pages

Team Fundraising Pages can be created on the Fundraising Platform to fundraise towards a charity as part of a team. The team will have a Team Fundraising Page and members of the team will each have an individual Personal Fundraising Page.

Each page will be created with a unique ID 'pfId' or 'teamId'.

The following table contains the fields that are returned within the response call of the team fundraising page endpoints.

Key	Label	Type	Description
supporterId	Supporter Id	Long	Supporter Id
companyId	Company Id	Long	Company Id
charityId	Charity Id	Long	Charity Id
charityAccountGuid	Charity Account Guid	UUID	Charity Account GUID
companyAccountGuid	Company Account Guid	UUID	Company Account GUID
campaignGuid	Campaign Guid	UUID	Campaign Guid
teamName	Team Name	String	Team Name
title	Title	String	Team fundraising page title
raisedAmount	Raised Amount	Long	Total amount raised
offlineDonationsTotal	Offline Donations Total	Long	Total amount raised offline
giftAidRaised	Gift Aid Raised	Long	Total amount of gift aid raised
createdDate	Created Date	Date	Date page was created
pageUrl	Page Url	String	Url of the page
pfId	Personal Fundraising ID	Long	This will be the Team Page ID
eventPageId	Event Page Id	Long	Event page Id
target	Target	Long	Target amount
status	Status	String	Status of the page, values can be: 0, open 1, closed
liveDate	Live Date	Date	Date page will be live
teamId	Team Id	Long	This will always be 0 as a team cannot be part of another team
lastUpdatedDate	Last Updated Date	Date	Date fundraising page was last updated

🚧
Reminder
If a supporterId is returned and has the value of 0. This is due to the fact a supporter was never created, which is caused by a fundraising page never having gone live.

🚀 Search Team Fundraising Pages

/teamFundraisingPage

Returns a list of team fundraising pages within your account filterable by the attributes below.

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the team fundraising page
event_ids	Event Ids	Array[Long]	Event Ids associated with the team fundraising page object
date_from	Date From	String	Date from which to filter based on the created date of the team fundraising page
date_to	Date To	String	Date to filter to based on the created date of the team fundraising page
new_team_fundraising_pages_only	New Team Fundraising Pages Only	Boolean	Used in conjunction with date filters, if set to true will filter using createdDate, otherwise will use both createdDate 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/teamFundraisingPage?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

{
  "status": 200,
  "teamFundraisingPageList": [
    {
      "createdDate": "2012-07-11 10:59:03",
      "supporterId": 67498,
      "companyId": 34143,
      "charityId": 65656,
      "charityAccountGuid": "976f2e51-4c64-4c5e-ad9d-462c85a92c0d",
      "companyAccountGuid": "ab30bc45-c5ae-46a4-bbc0-d4332a42334c",
      "campaignGuid": "123e4567-e89b-12d3-a456-426614174001",
      "teamName": "Katie 'team",
      "title": "Mrs",
      "raisedAmount": 125757,
      "offlineDonationsTotal": 10,
      "giftAidRaised": 1572,
      "pageUrl": "e5757575/pf/test",
      "pfId": 12121,
      "teamId": 12355475,
      "eventPageId": 123454575,
      "target": 125,
      "status": "N",
      "liveDate": null
      "lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
    },
    {
      "createdDate": "2022-01-01 10:59:03",
      "supporterId": 67498,
      "companyId": 34143,
      "charityId": 65656,
      "charityAccountGuid": "976f2e51-4c64-4c5e-ad9d-462c85a92c0d",
      "companyAccountGuid": "ab30bc45-c5ae-46a4-bbc0-d4332a42334c",
      "campaignGuid": "123e4567-e89b-12d3-a456-426614174001",
      "teamName": "Katie 'team",
      "title": "Mrs",
      "raisedAmount": 125757,
      "offlineDonationsTotal": 10,
      "giftAidRaised": 1572,
      "pageUrl": "e5757575/pf/test",
      "pfId": 32233,
      "teamId": 12355475,
      "eventPageId": 123454575,
      "target": 125,
      "status": "N",
      "liveDate": null
      "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 campaignGuid 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
}

🚀 Retrieves a Team Fundraising Page

/teamFundraisingPage/{pfid}

Get a team fundraising page filterable by a known pfId.

Key	Label	Type	Description
pfId	Personal Fundraising Page Id	String	Personal fundraising page Id

Sample Request

GET - http://dataapi.enthuse.com/teamFundraisingPage/123?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc

Sample Response:

200 - OK call was successful and returned data

{
  "campaignGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "charityAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "charityId": 7236487,
  "companyAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "companyId": 7236487,
  "createdDate": "2020-01-01 00:00:00",
  "eventPageId": 0,
  "giftAidRaised": 0,
  "liveDate": "2020-01-01 00:00:00",
  "offlineDonationsTotal": 0,
  "pageUrl": "string",
  "pfId": 0,
  "raisedAmount": 0,
  "status": "string",
  "supporterId": 7236487,
  "target": 0,
  "teamId": 0,
  "teamName": "string",
  "title": "string"
  "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
}

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

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