Get Family Fundraising Pledges | SchoolSet

curl https://app.schoolset.io/app/api/v1/family/id/fundraising/pledges \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "status": "success",
  "message": "Fundraising pledges retrieved successfully.",
  "data": [
    {
      "id": 1024,
      "donor": {
        "first_name": "Emily",
        "last_name": "Johnson",
        "address": "123 Maple Street, Springfield",
        "email": "emily.johnson@example.com"
      },
      "fund_id": 45,
      "fundraising_id": 12,
      "campaign_name": "Spring 2024 Library Renovation",
      "fund_name": "Library Fund",
      "payments": [
        {
          "payment_id": 501,
          "date": "2024-04-10",
          "amount": 150,
          "method": "credit_card",
          "status": "completed"
        }
      ],
      "pledge_date": "2024-03-15",
      "due_date": "2024-06-15",
      "start_date": "2024-03-20",
      "amount": 500,
      "balance": 350,
      "amount_due_today": 150,
      "total_paid": 150,
      "total_upcoming": 350,
      "currency": "USD",
      "status": "active",
      "auto_renew": false,
      "indefinite": false,
      "of_installments": 3,
      "amount_per_installment": 166.67,
      "recurring_period_id": 2,
      "frequency": "monthly",
      "period": {
        "start": "2024-03-20",
        "end": "2024-06-20"
      },
      "note": "Pledge made during school fundraiser event.",
      "cell_phone": "+1-555-123-4567",
      "email": "emily.johnson@example.com",
      "fundraiser_name": "Spring Fundraiser Committee",
      "created_by_user_id": 789,
      "pair": {
        "related_pledge_id": 1023,
        "relation_type": "matching_donation"
      },
      "last_payment": {
        "payment_id": 501,
        "date": "2024-04-10",
        "amount": 150,
        "method": "credit_card",
        "status": "completed"
      },
      "hash": "a1b2c3d4e5f67890",
      "created_at": "2024-03-15T09:00:00Z",
      "updated_at": "2024-04-10T10:30:00Z"
    }
  ]
}

Returns fundraising pledge information for the selected context.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Response

JSON response payload for family fundraising pledges.

statusenum

Allowed values:

messagestring

datalist of objects