Developer Documentation

Campaigns API Reference

Retrieve fundraising campaign data including goals, progress, and status using the FundraiserMax Campaigns API.

Campaigns

The Campaigns API provides read access to your fundraising campaigns, including goals, progress, and status information.

GET/v1/campaigns

Retrieve a paginated list of campaigns for your account.

NameTypeRequiredDescription
accountIdstringYesYour organization account ID.
limitnumberNoNumber of records to return (default 20, max 100).
offsetnumberNoNumber of records to skip for pagination (default 0).
curl -X GET "https://api.fundraisermax.com/api/v1/campaigns?accountId=acct_123&limit=10" \
  -H "X-API-Key: fmx_your_key_id" \
  -H "Authorization: Bearer your_api_secret"

Response

{
  "data": [
    {
      "id": "cmp_xyz789",
      "name": "Spring Annual Fund 2026",
      "description": "Annual spring fundraising drive",
      "goalAmount": 50000.00,
      "raisedAmount": 32150.00,
      "status": "active",
      "startDate": "2026-03-01T00:00:00Z",
      "endDate": "2026-05-31T23:59:59Z",
      "createdAt": "2026-01-10T09:00:00Z",
      "updatedAt": "2026-02-15T16:45:00Z"
    }
  ],
  "total": 5,
  "limit": 10,
  "offset": 0
}
GET/v1/campaigns/:id

Retrieve a single campaign by ID with full details including donation breakdown.

NameTypeRequiredDescription
accountIdstringYesYour organization account ID (query parameter).
idstringYesThe campaign ID (path parameter).
curl -X GET "https://api.fundraisermax.com/api/v1/campaigns/cmp_xyz789?accountId=acct_123" \
  -H "X-API-Key: fmx_your_key_id" \
  -H "Authorization: Bearer your_api_secret"

Response

{
  "id": "cmp_xyz789",
  "name": "Spring Annual Fund 2026",
  "description": "Annual spring fundraising drive",
  "goalAmount": 50000.00,
  "raisedAmount": 32150.00,
  "donorCount": 84,
  "averageDonation": 382.74,
  "status": "active",
  "startDate": "2026-03-01T00:00:00Z",
  "endDate": "2026-05-31T23:59:59Z",
  "createdAt": "2026-01-10T09:00:00Z",
  "updatedAt": "2026-02-15T16:45:00Z"
}