Listcampaigns | Virtuous Developer Documentation

{
  "items": [
    {
      "id": 1024,
      "name": "Spring Fundraiser 2024",
      "description": "Annual campaign to support local community projects during spring.",
      "startDate": "2024-03-01T00:00:00Z",
      "endDate": "2024-05-31T23:59:59Z",
      "duration": "3 months",
      "canSync": true,
      "crmKey": "SPRING2024",
      "crmKeyUrls": {
        "Salesforce": {
          "crmKey": "SPRING2024",
          "url": "https://salesforce.example.com/campaigns/SPRING2024"
        },
        "HubSpot": {
          "crmKey": "SPRING2024",
          "url": "https://app.hubspot.com/campaigns/SPRING2024"
        }
      },
      "applySegmentToRecurringGifts": true,
      "givingGoal": 50000,
      "givingGoalFormatted": "$50,000.00",
      "hasGivingGoal": true,
      "raisedAmount": "$32,500.00",
      "raisedPercentage": 65,
      "totalGiftGoal": 250,
      "hasTotalGiftGoal": true,
      "totalGifts": 180,
      "totalGiftsPercentage": 72,
      "totalDonors": 150,
      "averageGiftGoal": 200,
      "averageGiftGoalFormatted": "$200.00",
      "averageGiftAmount": "$180.56",
      "hasAverageGiftGoal": true,
      "totalVisitors": 1200,
      "conversionRate": "15.0%",
      "createdDateTime": "2024-01-15T10:00:00Z",
      "modifiedDateTime": "2024-04-10T16:45:00Z"
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Query parameters

FilterstringOptional

SkipintegerOptional

TakeintegerOptional

SortByenumOptional

Field to sort by (case-insensitive). Valid options: avggiftgoal, enddate, id, startdate

Allowed values:

DescendingbooleanOptional

IncludeDetailsbooleanOptional

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error