Gets a project by its unique code. | Virtuous Developer Documentation

{
  "id": 1024,
  "code": "PRJ2024X",
  "isActive": true,
  "isAvailableOnline": true,
  "isPublic": false,
  "isDeleted": false,
  "name": "Clean Water Initiative",
  "description": "A project dedicated to providing clean drinking water to rural communities.",
  "sortOrder": 5,
  "emailAddresses": "contact@cleanwater.org, info@cleanwater.org",
  "metadataFields": [
    {
      "name": "Region",
      "value": "Sub-Saharan Africa"
    }
  ],
  "image": "https://cdn.raisedonors.com/projects/cleanwater2024.jpg",
  "isPinned": true,
  "donorAmount": 350,
  "giftAmount": 1200,
  "createdDateTime": "2023-11-01T09:15:00Z",
  "modifiedDateTime": "2024-05-20T16:45:00Z",
  "raisedAmount": "450000.00",
  "averageGiftAmount": "1285.71",
  "firstGiftDate": "2023-11-02T10:00:00Z",
  "lastGiftDate": "2024-05-19T14:30:00Z",
  "isSystem": false,
  "percentageRecurringGift": 27.5,
  "externalIdentifier": "EXT-PRJ-2024-0001",
  "impactData": "{\"peopleServed\": 15000, \"wellsBuilt\": 25}"
}

Authentication

Authorizationstring

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

Path parameters

projectCodestringRequired

The project code to look up.

Response

idlongOptional

Gets or sets the identifier.

codestring or nullOptional

Gets or sets the code.

isActivebooleanOptional

Gets or sets a value indicating whether active.

isAvailableOnlinebooleanOptional

Gets or sets a value indicating whether available online.

isPublicbooleanOptional

Gets or sets a value indicating whether public.

isDeletedbooleanOptional

Gets or sets a value indicating whether deleted.

namestring or nullOptional

Gets or sets the name.

descriptionstring or nullOptional

Gets or sets the description.

sortOrderintegerOptional

Gets or sets the sort order.

emailAddressesstring or nullOptional

Gets or sets the email addresses.

metadataFieldslist of objects or nullOptional

Gets or sets the metadata fields.

imagestring or nullOptional

Gets or sets the image.

isPinnedbooleanOptional

Gets or sets a value indicating whether pinned.

donorAmountintegerOptional

Gets or sets the donor amount.

giftAmountintegerOptional

Gets or sets the gift amount.

createdDateTimestring or nullOptional

Gets or sets the created date time.

modifiedDateTimestring or nullOptional

Gets or sets the modified date time.

raisedAmountstring or nullOptional

Gets or sets the raised amount.

averageGiftAmountstring or nullOptional

Gets or sets the average gift amount.

firstGiftDatestring or nullOptional

Gets or sets the first gift date.

lastGiftDatestring or nullOptional

Gets or sets the last gift date.

isSystembooleanOptional

Gets or sets a value indicating whether system.

percentageRecurringGiftdoubleOptional

Gets or sets the percentage recurring gift.

externalIdentifierstring or nullOptional

Gets or sets the external identifier.

impactDatastring or nullOptional

Gets or sets the impact data.

Errors

404

Not Found Error