Find Projects

POST

/api/Project/Search

POST

/api/Project/Search

curl -X POST "https://api.virtuoussoftware.com/api/Project/Search?skip=1&take=1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "search": "<string>"
}'

{
  "list": [
    {
      "id": "<integer>",
      "name": "<string>",
      "projectCode": "<string>",
      "externalAccountingCode": "<string>",
      "onlineDisplayName": "<string>",
      "description": "<string>",
      "photoUrl": "<string>",
      "parentId": "<integer>",
      "parentName": "<string>",
      "isSubProject": "<boolean>",
      "inventoryStatus": "<string>",
      "type": "<string>",
      "location": "<string>",
      "isRestrictedToGiftSpecifications": "<boolean>",
      "isLimitedToFinancialNeed": "<boolean>",
      "isPublic": "<boolean>",
      "isActive": "<boolean>",
      "isAvailableOnline": "<boolean>",
      "isTaxDeductible": "<boolean>",
      "treatAsAccountsPayable": "<boolean>",
      "beginningBalance": "<double>",
      "currentBalance": "<double>",
      "financialNeedType": "<string>",
      "financialNeedFrequency": "<string>",
      "financialNeedAmount": "<double>",
      "startDate": "<dateTime>",
      "endDate": "<dateTime>",
      "durationType": "<string>",
      "lifeToDateGiving": "<double>",
      "lifeToDateGiftCount": "<integer>",
      "lifeToDateGiversCount": "<integer>",
      "lifeToDateExpenseTotal": "<double>",
      "calendarYearToDateGiving": "<double>",
      "calendarYearToDateGiftCount": "<integer>",
      "calendarYearToDateGiversCount": "<integer>",
      "calendarYearToDateExpenseTotal": "<double>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "giftSpecifications": [
        {
          "amount": "<double>",
          "frequency": "<string>"
        },
        {
          "amount": "<double>",
          "frequency": "<string>"
        }
      ],
      "customFields": "<object>"
    },
    {
      "id": "<integer>",
      "name": "<string>",
      "projectCode": "<string>",
      "externalAccountingCode": "<string>",
      "onlineDisplayName": "<string>",
      "description": "<string>",
      "photoUrl": "<string>",
      "parentId": "<integer>",
      "parentName": "<string>",
      "isSubProject": "<boolean>",
      "inventoryStatus": "<string>",
      "type": "<string>",
      "location": "<string>",
      "isRestrictedToGiftSpecifications": "<boolean>",
      "isLimitedToFinancialNeed": "<boolean>",
      "isPublic": "<boolean>",
      "isActive": "<boolean>",
      "isAvailableOnline": "<boolean>",
      "isTaxDeductible": "<boolean>",
      "treatAsAccountsPayable": "<boolean>",
      "beginningBalance": "<double>",
      "currentBalance": "<double>",
      "financialNeedType": "<string>",
      "financialNeedFrequency": "<string>",
      "financialNeedAmount": "<double>",
      "startDate": "<dateTime>",
      "endDate": "<dateTime>",
      "durationType": "<string>",
      "lifeToDateGiving": "<double>",
      "lifeToDateGiftCount": "<integer>",
      "lifeToDateGiversCount": "<integer>",
      "lifeToDateExpenseTotal": "<double>",
      "calendarYearToDateGiving": "<double>",
      "calendarYearToDateGiftCount": "<integer>",
      "calendarYearToDateGiversCount": "<integer>",
      "calendarYearToDateExpenseTotal": "<double>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>",
      "giftSpecifications": [
        {
          "amount": "<double>",
          "frequency": "<string>"
        },
        {
          "amount": "<double>",
          "frequency": "<string>"
        }
      ],
      "customFields": "<object>"
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

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

Query parameters

skipintegerOptional

How many items to skip.

takeintegerOptional

How many items to take.

Request

This endpoint expects an object.

searchstringOptional

Response

listlist of objectsOptional

totalstringOptional

Errors

400

Bad Request Error