Get a paginated list of projects. | Virtuous Developer Documentation

{
  "items": [
    {
      "id": 1024,
      "code": "PRJ-2024-07",
      "isActive": true,
      "isAvailableOnline": true,
      "isPublic": false,
      "isDeleted": false,
      "name": "Clean Water Initiative",
      "description": "A project focused on providing clean drinking water to rural communities.",
      "sortOrder": 10,
      "emailAddresses": "contact@cleanwater.org, info@cleanwater.org",
      "metadataFields": [
        {
          "name": "Region",
          "value": "Sub-Saharan Africa"
        }
      ],
      "image": "https://cdn.raisedonors.com/projects/cleanwater.jpg",
      "isPinned": true,
      "donorAmount": 350,
      "giftAmount": 1200,
      "createdDateTime": "2023-11-15T09:30:00Z",
      "modifiedDateTime": "2024-06-01T12:00:00Z",
      "raisedAmount": "125000.00",
      "averageGiftAmount": "104.17",
      "firstGiftDate": "2023-11-16T08:00:00Z",
      "lastGiftDate": "2024-05-30T17:45:00Z",
      "isSystem": false,
      "percentageRecurringGift": 27.5,
      "externalIdentifier": "EXT-CLW-2024",
      "impactData": "Provided clean water to 15,000 people in 2023."
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

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

Query parameters

IsActivebooleanOptional

Indicates if the project is active.

IsAvailableOnlinebooleanOptional

Indicates if the project is available online.

FilterstringOptional

SkipintegerOptional

TakeintegerOptional

SortByenumOptional

Field to sort by (case-insensitive). Valid options: code, donoramount, giftamount, id, isactive, name, raisedamount, status

DescendingbooleanOptional

IncludeDetailsbooleanOptional

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error