Show fundraising campaign

GET

https://app.schoolset.io/app/api/v1/public/fundraising/campaign/:school_id/:hash

GET

/app/api/v1/public/fundraising/campaign/:school_id/:hash

1 curl https://app.schoolset.io/app/api/v1/public/fundraising/campaign/school_id/hash \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Fundraising campaign retrieved successfully.",
4   "data": {
5     "id": 1024,
6     "campaign_name": "Spring Playground Renovation",
7     "description": "Raising funds to renovate the elementary school playground with new equipment and safety surfacing.",
8     "legal_name": "Greenwood Elementary School",
9     "status": {
10       "active": true,
11       "progress": "75%",
12       "goal_met": false
13     },
14     "hash": "a1b2c3d4e5f6g7h8i9j0",
15     "start_date": "2024-04-01T00:00:00Z",
16     "end_date": "2024-06-30T23:59:59Z",
17     "total_amount": 25000,
18     "balance_amount": 6250,
19     "success_payment_message": "Thank you for your generous donation!",
20     "file_manager_id": 458,
21     "image": "https://app.schoolset.io/media/campaigns/playground_renovation.jpg",
22     "donation_types": [
23       {
24         "id": 1,
25         "title": "Bronze Supporter",
26         "description": "Donation of $50 to support the playground project.",
27         "amount": 50,
28         "image": "https://app.schoolset.io/media/donations/bronze_badge.png",
29         "file_manager_id": 459,
30         "quantity_available": 100,
31         "quantity_left": 45
32       }
33     ],
34     "show_amount": true,
35     "email": "contact@greenwoodelementary.edu",
36     "phone": "+1-555-123-4567",
37     "currency": {
38       "code": "USD",
39       "symbol": "$",
40       "name": "US Dollar"
41     },
42     "fundraising_donation_type_sort": "amount",
43     "merchant_account_type_id": 3,
44     "merchant_account_id": 789,
45     "credit_card_required_rules": {
46       "min_amount": 10,
47       "max_amount": 5000,
48       "require_cvv": true
49     },
50     "account_id": 2048,
51     "school_payment": {
52       "payment_gateway": "Stripe",
53       "transaction_fee_percent": 2.9,
54       "transaction_fee_fixed": 0.3
55     },
56     "school_logo": "https://app.schoolset.io/media/schools/greenwood_logo.png",
57     "calendar": {
58       "timezone": "America/New_York",
59       "events": [
60         {
61           "date": "2024-05-15",
62           "event": "Mid-campaign fundraising update"
63         }
64       ]
65     }
66   }
67 }

Returns fundraising campaign information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

school_idstringRequired

hashstringRequired

Response

Successful GET response for /api/v1/public/fundraising/campaign/{school_id}/{hash}.

statusstring

messagestring

dataobject