Skip to content

Latest commit

 

History

History
63 lines (53 loc) · 2.78 KB

donors.md

File metadata and controls

63 lines (53 loc) · 2.78 KB

Donors

Donors associated with an Event, Participant, or Team.

Endpoints

Default orderBy: modifiedDateUTC DESC

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

Response

The response from the donors endpoint is an array of donor objects.

Example

[
  {
    "displayName": "Friendly Donor",
    "donorID": "EB8610A3FC435D58",
    "avatarImageURL": "https://static.donordrive.com/clients/try/img/avatar-constituent-default.gif",
    "modifiedDateUTC": "2019-10-30T18:01:18.513+0000",
    "sumDonations": 3500,
    "numDonations": 13,
    "recipientImageURL": "https://testdrive.donordrivecontent.com/try/images/$avatars$/constituent_8672DB7B-CE87-F677-6260FF8F15074828.jpg"
  },
  {
    "displayName": "Barnabas Jungleham",
    "donorID": "C650B80FC37D7464",
    "avatarImageURL": "https://static.donordrive.com/clients/try/img/avatar-constituent-default.gif",
    "modifiedDateUTC": "2019-10-14T15:35:27.370+0000",
    "sumDonations": 30,
    "numDonations": 1,
    "recipientImageURL": "https://testdrive.donordrivecontent.com/try/images/$avatars$/constituent_8672DB7B-CE87-F677-6260FF8F15074828.jpg"
  },
  {
    "displayName": "Kimberly Jalapeno",
    "donorID": "63135F1FCCEABD47",
    "avatarImageURL": "https://static.donordrive.com/clients/try/img/avatar-constituent-default.gif",
    "modifiedDateUTC": "2019-10-07T18:36:00.343+0000",
    "sumDonations": 200,
    "numDonations": 4,
    "recipientImageURL": "https://testdrive.donordrivecontent.com/try/images/$avatars$/constituent_8672DB7B-CE87-F677-6260FF8F15074828.jpg"
  }
]

Fields

Field Type Description Guaranteed Filterable Notes
avatarImageURL string The URL for the avatar image associated with the Donor Yes Yes
displayName string The Donor's name Yes Changed: 1.3
Dependent on privacy settings dictated by the Donor
donorID string The unique ID of the Donor Changed: 1.3
Dependent on privacy settings dictated by the Donor
modifiedDateUTC date The date (in UTC) this Donor last donated Yes Yes ISO-8601 format
numDonations integer The number of Donations this Donor has made to the Participant or Team Yes Yes
recipientImageURL string The URL for the avatar image associated with this Event, Participant, or Team Yes No
sumDonations float The sum total of Donations this Donor has made to the Participant or Team Yes Yes