List family fundraising pledges

GET

https://ssuccessv2.com/app/api/v1/family/:id/fundraising/pledges

GET

/app/api/v1/family/:id/fundraising/pledges

$ curl https://ssuccessv2.com/app/api/v1/family/1842/fundraising/pledges \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 771,
7       "amount": 1000,
8       "balance": 750,
9       "total_paid": 250,
10       "status": "Active",
11       "donor": {
12         "id": 4401,
13         "name": "Elena Garcia"
14       },
15       "fund_id": 14,
16       "fundraising_id": 88,
17       "campaign_name": "Spring Giving",
18       "fund_name": "Library Fund",
19       "payments": [],
20       "pledge_date": "string",
21       "due_date": "string",
22       "start_date": "string",
23       "amount_due_today": 250,
24       "total_upcoming": 0,
25       "currency": "USD",
26       "auto_renew": false,
27       "indefinite": false,
28       "of_installments": 4,
29       "amount_per_installment": 250,
30       "recurring_period_id": null,
31       "frequency": null,
32       "period": null,
33       "note": "Annual library pledge",
34       "cell_phone": "+1-917-555-0182",
35       "email": "family.garcia@example.com",
36       "fundraiser_name": "Elena Garcia",
37       "created_by_user_id": 17,
38       "pair": null,
39       "last_payment": null,
40       "hash": "abc123",
41       "created_at": "string",
42       "updated_at": "string",
43       "payment_plan": []
44     }
45   ]
46 }

Returns unique fundraising pledges associated with the family donors, including payment totals and current balance.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1

Response

Fundraising pledges returned.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error