Skip to content

Latest commit

 

History

History
74 lines (64 loc) · 2.97 KB

donations.md

File metadata and controls

74 lines (64 loc) · 2.97 KB
Raw

Donations

Donations associated with a Participant or Team.

Endpoints

Default orderBy: createdDateUTC DESC

Path Return Type Notes
/api/events/{eventID}/donations array To find {eventID}, visit your Event's Fundraising Page. Look for the &eventID= URL parameter.
/api/participants/{participantID}/donations array To find {participantID}, visit your Participant's Fundraising Page. Look for the &participantID= URL parameter.
/api/teams/{teamID}/donations array To find {teamID}, visit your Team's Fundraising Page. Look for the &teamID= URL parameter.

Response

The response from the donations endpoint is an array of donation objects.

Example

[
  {
    "displayName": "Friendly Donor",
    "participantID": 4024,
    "amount": 20,
    "donorID": "EB8610A3FC435D58",
    "avatarImageURL": "https://static.donordrive.com/clients/try/img/avatar-constituent-default.gif",
    "createdDateUTC": "2019-10-30T18:01:18.513+0000",
    "eventID": 581,
    "teamID": 5074,
    "donationID": "DF4E676D0828A8D5"
  },
  {
    "displayName": "Friendly Donor",
    "participantID": 4024,
    "amount": 10,
    "donorID": "DC3A81BE19445E15",
    "avatarImageURL": "https://static.donordrive.com/clients/try/img/avatar-constituent-default.gif",
    "createdDateUTC": "2019-10-28T16:02:42.583+0000",
    "eventID": 581,
    "teamID": 5074,
    "donationID": "F491FB1141299348",
    "incentiveID": "213F6CC8-9CFE-C59F-C3FE158798AFA7B1"
  },
  {
    "displayName": "The Donation Foundation",
    "participantID": 4024,
    "amount": 100,
    "donorID": "03F279F2BF01283D",
    "avatarImageURL": "https://static.donordrive.com/clients/try/img/avatar-constituent-default.gif",
    "createdDateUTC": "2019-10-26T15:26:13.290+0000",
    "eventID": 581,
    "teamID": 5074,
    "donationID": "3FF734E8C1657F6C"
  }
]

Fields

Field Type Description Guaranteed Filterable Notes
amount float The amount of this Donation Yes Dependent on privacy settings dictated by the Donor
avatarImageURL string The URL for the avatar image associated with the Donor Yes Yes
createdDateUTC date The date (in UTC) this Donation was created Yes Yes ISO-8601 format
displayName string The Donor's name Yes Dependent on privacy settings dictated by the Donor
donationID string The unique ID of this Donation Yes Yes
donorID string The unique ID of the Donor Yes Dependent on privacy settings dictated by the Donor
eventID integer The ID of the Event this Donor is associated with Yes Yes
incentiveID string The ID of the Fundraiser Incentive associated to this Donation Yes
message string The message from the Donor Yes Dependent on privacy settings dictated by the Donor
participantID integer The ID of the Participant associated to this Donation Yes Participant Donations only
teamID integer The ID of the Team associated to this Donation Yes Team Participant Donations and Team Donations only