List fundraising donors

GET

https://ssuccessv2.com/app/api/v2/fundraising/donor/page

GET

/app/api/v2/fundraising/donor/page

$ curl https://ssuccessv2.com/app/api/v2/fundraising/donor/page \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "current_page": 1,
6     "per_page": 25,
7     "total": 2,
8     "data": [
9       {
10         "id": 284,
11         "full_name": "David Cohen",
12         "company_name": null,
13         "type": "Individual",
14         "payer_type": "parent",
15         "deceased": null,
16         "vip": false,
17         "email": "david.cohen@example.com",
18         "cell_phone": "+1-212-555-0142",
19         "home_phone": null,
20         "spouse_full_name": "Sarah Cohen",
21         "spouse_email": "sarah.cohen@example.com",
22         "spouse_cell_phone": null,
23         "hebrew_name": "דוד כהן",
24         "spouse_hebrew_name": "שרה כהן",
25         "addresses": [],
26         "payer": {
27           "family_student_id": 91
28         },
29         "last_payment": {
30           "payment_date": {},
31           "amount_payment": 180
32         },
33         "next_payment": {
34           "payment_date": {},
35           "amount_payment": 180
36         },
37         "total_pledged": 3600,
38         "fundraising_payments_total_amounts": 1800,
39         "total_balance": 1800,
40         "processing_fee_blocked": false,
41         "is_processing_fee_blocked": false
42       }
43     ]
44   }
45 }

Returns a paginated donor view with supported filters, sorting, addresses, payer summaries, and payment totals for the active school.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Query parameters

pageintegerOptional>=1

per_pageintegerOptional1-200

sortstringOptional

filter[search]stringOptional

filter[processing_fee_blocked][]enumOptional

Allowed values:

filter[payer_type][]stringOptional

filter[fundraising_id][]integerOptional

Response

A paginated collection of donor page resource records was returned.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error