Skip to main content

Donation related

Get Donations Details

Gets details about the donations done by the Users for the Events in the provided date range.

MethodURLAPI key Authentication
GET/PartnerServices/GetDonationDetailsREQUIRED

Request Query Parameters

ParameterTypeRequiredDescriptionFormat Allowed
fromDateStringDonation filter's start date.yyyy-mm-dd Date
2023-12-31
toDateStringDonation filter's end date.yyyy-mm-dd Date
2023-12-31
Example Query Parameters
?fromDate=2023-10-25&toDate=2023-12-31

Response Status Codes

Status CodeDescription
200 - OKWhen the Donation details are retrieved successfully.
400 - Bad RequestWhen the request is invalid or missing required parameters.

Scenarios
• Missing API key
• Missing required fields
• Either field fromDate or toDate have an invalid date format
401 - UnauthorizedWhen the API key is incorrect.
500 - Internal Server ErrorWhen any exception occurred.

Success Response Format

Returns a list of donations details in the form of a JSON array of Donation objects.

Example Response Body
[
{
"transactionId": "abcd123456",
"kindlyUserId": "10473963d373401fa1430096bfb38da7",
"volunteerFirstName": "John",
"volunteerLastName": "Doe",
"donorMatch": 20,
"email": "johndoe@gmail.com",
"zipCode": "99501",
"phoneNumber": "1585301498",
"kindlyShiftId": "e0b4a43800a24116ad269608ec0178d7",
"location": "The ABCD university",
"kindlyDonorId": "10473963d373401fa1430096bfb38da7",
"donorFirstName": "Bruce",
"donorLastName": "Lee",
"donation": 80,
"createdDate": "2023-08-18T18:00:00+00:00",
"donationTriggeredDate": "2023-08-20T10:00:00+00:00",
"elapsedTime": "40h:00m"
}
]