Skip to main content
GET
Get a Project

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required

(Required) The project identifier.

Response

OK

id
string

The unique identifier of the record in Virtuous.

name
string

The display name of the record.

projectCode
string
externalAccountingCode
string
onlineDisplayName
string
description
string

The free-text description stored on the record.

photoUrl
string
parentId
string
parentName
string
isSubProject
string
inventoryStatus
string
type
string
location
string
isRestrictedToGiftSpecifications
string
isLimitedToFinancialNeed
string
isPublic
string
isActive
string
isAvailableOnline
string
isTaxDeductible
string
treatAsAccountsPayable
string
beginningBalance
string
currentBalance
string
financialNeedType
string
financialNeedFrequency
string
financialNeedAmount
string
startDate
string
endDate
string
durationType
string
lifeToDateGiving
string

The total amount the contact has given since the first gift.

lifeToDateGiftCount
string
lifeToDateGiversCount
string
lifeToDateExpenseTotal
string
calendarYearToDateGiving
string
calendarYearToDateGiftCount
string
calendarYearToDateGiversCount
string
calendarYearToDateExpenseTotal
string
createDateTimeUtc
string

The UTC date and time the record was created.

createdByUser
string

The name of the user who created the record.

modifiedDateTimeUtc
string

The UTC date and time the record was last modified.

modifiedByUser
string

The name of the user who last modified the record.

giftSpecifications
object[]
customFields
string

The custom field values stored on the record.

Last modified on July 24, 2026